Sign in

v1

latestOpenAPI 3.0.02026-07-26866217.8 KB
Messages

Send Special Offer

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.

post/conversations/{conversation_id}/special_offers

Path parameters

conversation_idstring required

The id of the conversation.

Request body

listing_idstring required

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

check_in_datestring date required

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

check_out_datestring date required

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

pricenumber required

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

number_of_adultsinteger required

Number of adults.

number_of_childreninteger

Number of children. Defaults to 0.

number_of_infantsinteger

Number of infants. Defaults to 0.

number_of_petsinteger

Number of pets. Defaults to 0.

rate_plan_idstring

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

currencystring

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

Response

The request has been successfully submitted.

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

Example response

{
  "error_msg": "Done."
}