Skip to content

/v1/holds

POST
/v1/holds
curl --request POST \
--url http://localhost:8787/v1/holds \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "partySize": 1, "signedQuoteToken": "example" }'
Media typeapplication/json
object
partySize
integer
> 0
signedQuoteToken
required
string
>= 1 characters
Examplegenerated
{
"partySize": 1,
"signedQuoteToken": "example"
}

The SAME reservation a prior request with this Idempotency-Key already created.

Media typeapplication/json
object
createdAt
required
string
currency
required
string
>= 3 characters <= 3 characters
endsAt
required
string
holdExpiresAt
required
string | null
id
required
string format: uuid
ratePlanId
required
string | null format: uuid
resourceId
required
string format: uuid
startsAt
required
string
state
required
string
Allowed values: pending held confirmed cancelled checked_in checked_out no_show expired
totalMinorUnits
required
string
/^\d+$/
Example
{
"state": "pending"
}

A new held reservation.

Media typeapplication/json
object
createdAt
required
string
currency
required
string
>= 3 characters <= 3 characters
endsAt
required
string
holdExpiresAt
required
string | null
id
required
string format: uuid
ratePlanId
required
string | null format: uuid
resourceId
required
string format: uuid
startsAt
required
string
state
required
string
Allowed values: pending held confirmed cancelled checked_in checked_out no_show expired
totalMinorUnits
required
string
/^\d+$/
Example
{
"state": "pending"
}

Missing Idempotency-Key header, or an invalid/expired/tampered quote token.

Media typeapplication/problem+json
object
code
required
string
Allowed values: idempotency_key_required invalid_quote_token quote_expired resource_locked hold_conflict
detail
required
string
status
required
number
title
required
string
type
required
string
Example
{
"code": "idempotency_key_required"
}

The resource+window is locked by a concurrent hold attempt, or already booked.

Media typeapplication/problem+json
object
code
required
string
Allowed values: idempotency_key_required invalid_quote_token quote_expired resource_locked hold_conflict
detail
required
string
status
required
number
title
required
string
type
required
string
Example
{
"code": "idempotency_key_required"
}