Skip to content
Public API reference
/
/V4 Gifts

V4 Gifts

Create a Gift resource for V4. Gifts can be used to provide access to a particular URL for one session only by appending a gift token ID to the URL as the gift path parameter.

Operations

Create a gift V4

Request

Creates a gift (V4).

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Bodyapplication/json
pathstringrequired

The gift will be created for the provided path in the request body.

Example:"/my-path"
{
  "path": "/my-path"
}

Responses

Created

Headers
any
Bodyapplication/json
tokenstring

The token of the created gift.

Example:"absd-acsd34-casdae-1243c"
claimPathstring

The path that was generated for claiming the gift.

Example:"/my-path?gift=absd-acsd34-casdae-1243c"
Response
{
  "token": "absd-acsd34-casdae-1243c",
  "claimPath": "/my-path?gift=absd-acsd34-casdae-1243c"
}