Skip to main content

Cancel Session

Cancel one session of a series. Only that session's booking is cancelled โ€” every other session in the program is untouched, and the series itself stays active. To cancel all upcoming sessions at once, use Cancel Series.

Endpointโ€‹

POST /v1/series/{id}/sessions/{sessionId}/cancel

Authenticationโ€‹

Requires a live or test API key with series:write scope.

Path Parametersโ€‹

ParameterTypeDescription
idintegerSeries ID
sessionIdintegerSeries-session ID (sessions[].id from Get Series)

Request Bodyโ€‹

No request body.

Example Requestโ€‹

curl -X POST "https://app.equipdash.com/api/v1/series/1/sessions/102/cancel" \
-H "Authorization: Bearer YOUR_API_KEY"

Responseโ€‹

Success (200 OK)โ€‹

Returns the series in the same shape as Get Series, including totals, with the cancelled session's booking showing a cancelled status.

{
"data": {
"id": 1,
"name": "Intro Course โ€” Tuesday Group",
"experience": {
"id": 12,
"name": "Intro Course"
},
"group": {
"id": 7,
"name": "Tuesday Group"
},
"billing_mode": "consolidated",
"status": "active",
"totals": {
"total": 450.00,
"paid": 150.00,
"balance": 300.00
},
"sessions": [
{
"id": 101,
"session_index": 1,
"schedule": {
"id": 501,
"start_datetime_utc": "2026-09-01T17:00:00Z",
"end_datetime_utc": "2026-09-01T18:30:00Z"
},
"booking": {
"id": 9001,
"status": "confirmed",
"payment_status": "paid"
},
"created_at": "2026-07-20T10:00:00Z",
"updated_at": "2026-07-20T10:00:00Z"
},
{
"id": 102,
"session_index": 2,
"schedule": {
"id": 502,
"start_datetime_utc": "2026-09-08T17:00:00Z",
"end_datetime_utc": "2026-09-08T18:30:00Z"
},
"booking": {
"id": 9002,
"status": "cancelled",
"payment_status": "pending"
},
"created_at": "2026-07-20T10:00:00Z",
"updated_at": "2026-07-21T11:15:00Z"
}
],
"created_at": "2026-07-20T10:00:00Z",
"updated_at": "2026-07-21T11:15:00Z"
},
"meta": {
"request_id": "req_abc123"
}
}

Errorsโ€‹

StatusCodeDescription
401authentication_requiredNo API key provided
403insufficient_scopeAPI key lacks series:write scope
403forbiddenSeries belongs to a different supplier
404resource_not_foundSeries or session does not exist

Notesโ€‹

  • The supplier's cancellation policy applies to the session's booking, exactly as if it were cancelled on its own
  • Cancelling a session does not issue refunds automatically โ€” refund the paid booking through the Bookings API as needed