Add a member to an alert list using slot reference
POST /api/bookings/{memberId}/alert-list
Success: 200 OK
- Products: Operator (
FOH), Consumer (CONSUMER) (any one of these products, not all) - Features: Online Bookings (
ONLINEBOOK), Front of House Generic Access (FOHGENERIC) (any one of these features, not all)
Overview
Adds a member to the alert list (waiting list) for a session, identified by the slot reference you already hold from availability. The endpoint takes the booking from the slot reference and puts the member on that booking's alert list, returning their place in the queue.
Only classes and courses can have alert lists, and only when the activity is configured to
allow one — a slot reference for an ordinary activity, or for a class with alert lists
switched off, is rejected with 400. A member can appear on a booking's alert list once:
a second attempt, or an attempt by a member already booked on to the session, is also
rejected with 400.
Joining the alert list creates an unpaid booking record flagged as waiting. That record
does not occupy a space: members flagged as waiting are excluded from the counts used to
decide whether a session is full. Converting a waiting member into a confirmed booking is
a separate call, POST /api/bookings/promote-from-alert-list.
If you hold the numeric booking id rather than a slot reference, use
POST /api/bookings/{memberId}/alert-list/{bookingId} instead; it performs the same work
without the slot-reference step.
Use this endpoint to:
- Put a member on the waiting list for a session that is full
- Report back the member's position in that queue
Endpoint
POST {base_url}/api/bookings/{memberId}/alert-list
{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
memberId | integer (int32) | Yes | The member joining the alert list. Must be a positive integer and must be an existing member, otherwise 404 is returned. It must also match the member the access token was issued for, or one of their linked members. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
slotReference | string | Yes | The slot reference string for the session, passed through unchanged from the availability response (each slot carries one under slotReferences.inCentre and slotReferences.virtual). It is a JSON document, and only its bookingId is used. A value that is not a valid slot-reference document is rejected with Invalid SlotReference {value}: cannot be deserialized, and a reference whose bookingId is not a positive integer or does not exist is rejected with 400. |
Sample request
curl -X POST '{base_url}/api/bookings/{memberId}/alert-list' \
-H 'Authorization: Bearer {accessToken}' \
-H 'X-Use-SSO: true' \
-H 'Content-Type: application/json' \
-d '{
"slotReference": "string"
}'Response fields
| Field | Type | Description |
|---|---|---|
alertListPosition | integer (int32) | The member's place in the queue for that booking, counted as they are added: the number of members already flagged as waiting, plus one. The first member to join receives 1. It is a snapshot at the time of the call, not a stable identifier — it does not shift as members ahead are promoted or removed. |
Sample response
{
"alertListPosition": 1
}Errors
| Status | Meaning | When |
|---|---|---|
400 | Bad request | The slot reference is not a valid slot-reference document; its booking id is not a positive integer or the booking does not exist; the booking's activity is not a class or course ("Only classes and courses can have alert lists"); the activity is not configured for alert lists; or the member is already on the alert list for, or already booked on to, that booking. |
404 | Not found | The member id does not exist (Invalid Member ID {memberId}: member doesn't exist). |
500 | Internal server error | An unexpected server-side failure while adding the member to the list. |