Docs
Sites APIConversion

Reserve a tour

Books a tour with the provider and creates the lead. `fields` is validated against the connection's tour schema for the tour type, the same schema GET /integrations publishes. Call from the site's own server. Send an `Idempotency-Key`: a retry after a timeout then returns the original booking instead of booking the slot twice with the provider.

POST/api/sites/v1/tours/reservations

Books a tour with the provider and creates the lead. fields is validated against the connection's tour schema for the tour type, the same schema GET /integrations publishes. Call from the site's own server. Send an Idempotency-Key: a retry after a timeout then returns the original booking instead of booking the slot twice with the provider.

Authorization

websiteToken
AuthorizationBearer <token>

A Sanctum token scoped to one website.

In: header

Header Parameters

X-Resi-Website?string

Website id. Overrides Host resolution for builds running where Host is meaningless. The token must still be scoped to this website.

Idempotency-Key?string

Any unique string per submission or booking. A repeat within 24 hours returns the original result and creates nothing.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/sites/v1/tours/reservations" \  -H "Content-Type: application/json" \  -d '{    "property": "string",    "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9",    "tour_type": "string",    "tour_date": "string",    "tour_time": "string",    "fields": {}  }'
{  "data": {    "lead_id": "string",    "message": "string"  },  "meta": {    "duplicate": true  }}

Tour availability POST

Asks the property's tour provider for open slots. The connection must be an enabled tour connection of this property, and the tour type one it offers. Limited to 60 requests a minute per website.

Record an analytics event POST

A demand event a page observed, forwarded by the site's server. Uses the read rate limit, since events arrive in volume.