Send Special Offer

post

https://api.hostex.io/v3/conversations/{conversation_id}/special_offers

Send a special offer to the guest in a conversation. A special offer invites the guest to book the given listing for the given dates at a custom total price, and typically expires 24 hours after being sent. Supported on Airbnb and booking-site (direct booking) conversations only; requests on other channels return an error. For booking-site conversations, rate_plan_id and currency are also required.

Path Params

conversation_id

string

required

The id of the conversation.

Body Params

listing_id

string

required

The channel listing id to offer, as returned by GET /listings.

check_in_date

date

required

Check-in date of the offered stay, YYYY-MM-DD.

check_out_date

date

required

Check-out date of the offered stay, YYYY-MM-DD. Must be after check_in_date.

price

number

required

Total price for the whole stay, in major currency units (not per night).

number_of_adults

integer

required

≥ 1

Number of adults.

number_of_children

integer

≥ 0

Number of children. Defaults to 0.

number_of_infants

integer

≥ 0

Number of infants. Defaults to 0.

number_of_pets

integer

≥ 0

Number of pets. Defaults to 0.

rate_plan_id

string

The rate plan to offer. Required for booking-site (direct booking) conversations; ignored on Airbnb.

currency

string

Currency code of price, e.g. USD. Required for booking-site (direct booking) conversations; ignored on Airbnb.

Response

200The request has been successfully submitted.