Skip to main content
POST
curl

Authorizations

Authorization
string
header
required

Org-API-Key as a Bearer token.

Headers

Idempotency-Key
string

Optional client-generated key (<=255 chars). A retried POST carrying the same key replays the original response instead of acting twice; reusing a key with a different body returns 409.

Maximum string length: 255

Body

application/json
offer
string
required
adults
integer
blackoutDates
string[]

A calendar date, YYYY-MM-DD. Not a datetime.

children
integer
contactMethod
enum<string>
Available options:
APP_CHAT,
SMS,
EMAIL,
PHONE
contactWindow
enum<string>
Available options:
MORNING,
AFTERNOON,
EVENING,
ANYTIME
externalUserID
string
occasion
enum<string>
Available options:
BIRTHDAY,
ANNIVERSARY,
ENGAGEMENT,
WEDDING,
GRADUATION,
PROMOTION,
BUSINESS,
OTHER
phone
string
preferredDates
string[]

A calendar date, YYYY-MM-DD. Not a datetime.

Response

Response for status 201

conversationId
string | null
required
createdAt
string
required
id
string
required
intake
object | null
required
offer
string
required
status
string
required