Create a cue call
Show module
POST/cue-callscueCalls.create
A department's call on a cue (1180): the audio, lighting, video, special effects or stage instruction given when the cue fires. The Run of Show sheet holds one column per department. Creates a cue call. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability show.run_of_show.write.
- OAuth scopes: show.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: CueCallCreate
| Field | Type | Required | Description |
|---|---|---|---|
| cue_id | string (uuid) | Yes | Identifier of the cue the call belongs to. |
| call_kind | "Audio" | "Lighting" | "Video" | "Special Effects" | "Stage" | Yes | Department making the call. |
| instruction | string | Yes | What the department does on the cue.Constraints: length 1 to 2000 |
{
"cue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"call_kind": "Lighting",
"instruction": "LX 14 GO, house to half."
}Response 201: CueCall
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the cue call. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row. |
| cue_id | string (uuid) | Yes | Identifier of the cue the call belongs to. |
| call_kind | "Audio" | "Lighting" | "Video" | "Special Effects" | "Stage" | Yes | Department making the call. |
| instruction | string | Yes | What the department does on the cue.Constraints: length 1 to 2000 |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"cue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"call_kind": "Lighting",
"instruction": "LX 14 GO, house to half."
}Code samples
curl -X POST "$XOS_BASE_URL/cue-calls" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"cue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","call_kind":"Lighting","instruction":"LX 14 GO, house to half."}'const { data } = await xos.cueCalls.create({
"cue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"call_kind": "Lighting",
"instruction": "LX 14 GO, house to half."
});response = xos.cue_calls.create({"cue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "call_kind": "Lighting", "instruction": "LX 14 GO, house to half."})xos cue-calls create --data '{"cue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","call_kind":"Lighting","instruction":"LX 14 GO, house to half."}'