Docs
Sites APIConversion

Submit a form

Creates a lead. Call this from the site's own server with the website token; the token must never reach a browser. The lead takes the same path as any other: created and recorded as a demand event before the response; email notifications and the form's CRM connections run just after it, so a slow CRM never holds the form open. Limited to 60 requests a minute per website.

POST/api/sites/v1/forms/{form}/submissions

Creates a lead. Call this from the site's own server with the website token; the token must never reach a browser. The lead takes the same path as any other: created and recorded as a demand event before the response; email notifications and the form's CRM connections run just after it, so a slow CRM never holds the form open. Limited to 60 requests a minute per website.

Authorization

websiteToken
AuthorizationBearer <token>

A Sanctum token scoped to one website.

In: header

Path Parameters

form*string

The form's id.

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

curl -X POST "https://example.com/api/sites/v1/forms/string/submissions" \  -H "Content-Type: application/json" \  -d '{    "fields": {}  }'
{  "data": {    "lead_id": "string",    "message": "string",    "redirect_url": "string"  },  "meta": {    "duplicate": true,    "discarded": true  }}

One form GET

A form by id. A form on no property of this website, a disabled form and a malformed id are all a 404. Tags: `forms:{property_id}`.

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.