Skip to content
Booking Engine API Docs

/v1/holds/{reservationId}/otp

POST
/v1/holds/{reservationId}/otp
curl --request POST \
  --url http://localhost:8787/v1/holds/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/otp \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
reservationId
required
string format: uuid

Request Body

Section titled “Request Body”
Media typeapplication/json
object
email
required
string format: email
Examplegenerated
{
  "email": "hello@example.com"
}

Responses

Section titled “Responses”

202

Section titled “202”

OTP issued and emailed to the guest (fake EmailPort in tests).

Media typeapplication/json
object
accepted
required
boolean
expiresAt
required
string
Example
{
  "accepted": true
}

404

Section titled “404”

No such hold for this API key’s tenant.

Media typeapplication/problem+json
object
code
required
string
Allowed values: hold_not_found hold_not_held bad_code expired exhausted_attempts rate_limited
detail
required
string
status
required
number
title
required
string
type
required
string
Example
{
  "code": "hold_not_found"
}

409

Section titled “409”

Hold exists but is not an active (unexpired, held) hold.

Media typeapplication/problem+json
object
code
required
string
Allowed values: hold_not_found hold_not_held bad_code expired exhausted_attempts rate_limited
detail
required
string
status
required
number
title
required
string
type
required
string
Example
{
  "code": "hold_not_found"
}

429

Section titled “429”

OTP-issue rate limit exceeded for this hold.

Media typeapplication/problem+json
object
code
required
string
Allowed values: hold_not_found hold_not_held bad_code expired exhausted_attempts rate_limited
detail
required
string
status
required
number
title
required
string
type
required
string
Example
{
  "code": "hold_not_found"
}