hosting
PUT /v1/sites/{siteId}/forms
Switch a site's own forms on or off.
Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/forms \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "enabled": <boolean> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
ON creates the site's own Turnstile widget the first time (one Cloudflare call) and afterwards only flips a flag, so the sitekey on the page stays valid. OFF keeps the widget and refuses the site's submissions from the next request on (not_enabled). 409 (refusal.siteForms.noMailbox) when the site's domain has no mailbox to send to; 503 (refusal.siteForms.notReady) when the widget cannot be created just now. Audit-logged. Requires sites.view and sites.panel_access.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
enabled | boolean | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
available | boolean | Yes | False when the site's domain has no mailbox to send to. |
enabled | boolean | Yes | — |
sitekey | string | Yes | PUBLIC Turnstile sitekey for the page's widget; empty until first switched on. |
endpoint | string | Yes | The form's action URL (submitSiteForm). |
domain | string | Yes | The site's own domain; the form's _to is a mailbox local part on it. |
mailboxes | string[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 409 · 422 · 429 · 503