Saltar al contenido

Update a cue call

Módulo Show

PATCH/cue-calls/{id}cueCalls.update

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. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requiere la capacidad show.run_of_show.write.
  • Alcances de OAuth: show.
  • Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
  • Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

cueCalls.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the cue call.

Cuerpo de la solicitud: CueCallUpdate

cueCalls.update: CueCallUpdate
CampoTipoObligatorioDescripción
call_kind"Audio" | "Lighting" | "Video" | "Special Effects" | "Stage"NoDepartment making the call.
instructionstringNoWhat the department does on the cue.Restricciones: length 1 to 2000
{
  "call_kind": "Lighting",
  "instruction": "LX 14 GO, house to half."
}

Respuesta 200: CueCall

cueCalls.update: CueCall
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the cue call.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row.
cue_idstring (uuid)SíIdentifier of the cue the call belongs to.
call_kind"Audio" | "Lighting" | "Video" | "Special Effects" | "Stage"SíDepartment making the call.
instructionstringSíWhat the department does on the cue.Restricciones: 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."
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/cue-calls/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"call_kind":"Lighting","instruction":"LX 14 GO, house to half."}'
const { data, etag } = await xos.cueCalls.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "call_kind": "Lighting",
    "instruction": "LX 14 GO, house to half."
  }, { ifMatch: etag });
response = xos.cue_calls.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"call_kind": "Lighting", "instruction": "LX 14 GO, house to half."}, if_match=etag)
xos cue-calls update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"call_kind":"Lighting","instruction":"LX 14 GO, house to half."}' --if-match auto