hosting
POST /v1/sites/{siteId}/exam-boost/{boostId}/cancel
Cancel a boost before it starts, or end a running one early.
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 POST https://api.zinndigital.com/v1/sites/{siteId}/exam-boost/{boostId}/cancel \
-H "Authorization: Bearer zdk_live_…"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
Before the start: a free boost is cancelled and the site's free boost of the year is given back; a paid boost is cancelled and its charge is refunded as Zinn® credit (never to the card). After the start: the boost ends now, the site goes back to its plan, and nothing is refunded. A finished boost is 422 refusal.examBoost.notCancellable. Requires sites.view and billing.payment.manage.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
boostId (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
site_id | string | Yes | — |
offered | boolean | Yes | — |
free_available | boolean | Yes | — |
next_free_on | string | Yes | — |
price | ExamBoostMoney | Yes | — |
duration_days | integer | Yes | — |
multiplier | integer | Yes | — |
max_lead_days | integer | Yes | — |
plan_limits | ExamBoostLimits | Yes | — |
boosted_limits | ExamBoostLimits | Yes | — |
current | ExamBoostBooking | Yes | — |
history | ExamBoostBooking[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429