Skip to main content
POST
/
v1
/
admin
/
catalog
/
holds
/
place
Place a capacity hold
curl --request POST \
  --url https://{operatorDomain}/v1/admin/catalog/holds/place \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityModule": "<string>",
  "entityId": "<string>",
  "draftId": "<string>",
  "ttlMs": 123,
  "parameters": {}
}
'
{
  "holdToken": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Staff session or API token issued by your Voyant app.

Body

application/json
​
entityModule
string
required
​
entityId
string
required
​
draftId
string
required
​
ttlMs
integer
​
parameters
object

Response

200 - application/json

Hold token

​
holdToken
string
​
expiresAt
string<date-time>