Saltar al contenido
XOS para desarrolladores

Create a shift

Módulo Crew

POST/shiftsshifts.create

A staffed crew block. A shift cannot end before it starts. Creates a shift. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requiere la capacidad crew.shift.write.
  • Alcances de OAuth: crew.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: ShiftCreate

shifts.create: ShiftCreate
CampoTipoObligatorioDescripción
project_idstring (uuid)SíIdentifier of the project.
record_idstring (uuid) | nullNoIdentifier of the Shift record.
role_codeRoleCode | nullNo
engagement_idstring (uuid) | nullNoIdentifier of the engagement.
starts_atstring (date-time)SíCall time.
ends_atstring (date-time)SíWrap time.
membership_idstring (uuid) | nullNoIdentifier of the membership of the person on the shift; null for external crew, who carry an engagement.
scope_node_idstring (uuid) | nullNoIdentifier of the scope node of the same project, such as the show.
time_zonestringSíIANA time zone the call and wrap times are shown in.Restricciones: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$
scheduled_break_minutesinteger | nullNoMeal break scheduled within the shift, in minutes.Restricciones: range 0 to any
{
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "starts_at": "2026-10-08T14:30:00Z",
  "ends_at": "2026-10-08T14:30:00Z",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "time_zone": "America/New_York",
  "scheduled_break_minutes": 30
}

Respuesta 201: Shift

shifts.create: Shift
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the shift.
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; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_idstring (uuid)SíIdentifier of the project.
record_idstring (uuid) | nullSíIdentifier of the Shift record.
role_codeRoleCode | nullSí
engagement_idstring (uuid) | nullSíIdentifier of the engagement.
starts_atstring (date-time)SíCall time.
ends_atstring (date-time)SíWrap time.
shift_state"Draft" | "Published" | "Accepted" | "Canceled"SíShift state.
membership_idstring (uuid) | nullSíIdentifier of the membership of the person on the shift; null for external crew, who carry an engagement.
scope_node_idstring (uuid) | nullSíIdentifier of the scope node of the same project, such as the show.
time_zonestringSíIANA time zone the call and wrap times are shown in.Restricciones: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$
scheduled_break_minutesinteger | nullSíMeal break scheduled within the shift, in minutes.Restricciones: range 0 to any
{
  "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",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "role_code": "5000.50.01",
  "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "starts_at": "2026-10-08T14:30:00Z",
  "ends_at": "2026-10-08T14:30:00Z",
  "shift_state": "Draft",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "time_zone": "America/New_York",
  "scheduled_break_minutes": 30
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/shifts" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","starts_at":"2026-10-08T14:30:00Z","ends_at":"2026-10-08T14:30:00Z","membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","scope_node_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","time_zone":"America/New_York","scheduled_break_minutes":30}'
const { data } = await xos.shifts.create({
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "starts_at": "2026-10-08T14:30:00Z",
    "ends_at": "2026-10-08T14:30:00Z",
    "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "time_zone": "America/New_York",
    "scheduled_break_minutes": 30
  });
response = xos.shifts.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "starts_at": "2026-10-08T14:30:00Z", "ends_at": "2026-10-08T14:30:00Z", "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "time_zone": "America/New_York", "scheduled_break_minutes": 30})
xos shifts create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","starts_at":"2026-10-08T14:30:00Z","ends_at":"2026-10-08T14:30:00Z","membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","scope_node_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","time_zone":"America/New_York","scheduled_break_minutes":30}'