hosting
POST /v1/sites/{siteId}/exam-boost
Book an Exam Boost now or for a scheduled start.
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 \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'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
Books a boost starting at starts_at (omitted or past = now; at most 180 days ahead). When the site's free boost of the year is available it is used and nothing is charged; otherwise the boost is bought as the moodle_exam_boost extra (wallet credit first, then the saved method on gateway). A site that already holds a live boost, an account not in good standing (§2.46), a bad start or a declined charge is 422 with a refusal.examBoost.* key; a missing payment method is 422 PAYMENT_METHOD_REQUIRED with the payment step. Requires sites.view and billing.payment.manage.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
starts_at | string | No | — |
gateway | string | No | — |
currency | string | No | — |
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