Create a run of show
Show module
POST/run-of-showrunsOfShow.create
A run of show for one show scope node. Creates a run of show. 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: RunOfShowCreate
| Field | Type | Required | Description |
|---|---|---|---|
| scope_node_id | string (uuid) | null | No | Identifier of the show scope node. |
| name | string | Yes | Run of show title.Constraints: length 1 to 300 |
| show_date | string (date) | Yes | Show date. |
| project_id | string (uuid) | Yes | Identifier of the project of the running order. |
| record_id | string (uuid) | null | No | Identifier of the schedule record the running order belongs to, in the same project. |
{
"scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Saturday Main Stage",
"show_date": "2026-10-08",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Response 201: RunOfShow
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the run of show. |
| 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; null when a seed, platform or system process created it. |
| 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; null when a seed, platform or system process updated it. |
| scope_node_id | string (uuid) | null | Yes | Identifier of the show scope node. |
| name | string | Yes | Run of show title.Constraints: length 1 to 300 |
| show_date | string (date) | Yes | Show date. |
| project_id | string (uuid) | Yes | Identifier of the project of the running order. |
| record_id | string (uuid) | null | Yes | Identifier of the schedule record the running order belongs to, in the same project. |
{
"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",
"scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Saturday Main Stage",
"show_date": "2026-10-08",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X POST "$XOS_BASE_URL/run-of-show" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"scope_node_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","name":"Saturday Main Stage","show_date":"2026-10-08","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'const { data } = await xos.runsOfShow.create({
"scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Saturday Main Stage",
"show_date": "2026-10-08",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
});response = xos.runs_of_show.create({"scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "name": "Saturday Main Stage", "show_date": "2026-10-08", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})xos runs-of-show create --data '{"scope_node_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","name":"Saturday Main Stage","show_date":"2026-10-08","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'