Update a workforce event

Workforce module

PATCH/workforce-events/{id}workforceEvents.update

A briefing, crew call or meeting for an audience, with RSVP, location, agenda and check-in. 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.

Requires the capability schedule.timeline.write.
OAuth scopes: schedule.
Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

workforceEvents.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the workforce event.

Request body: WorkforceEventUpdate

workforceEvents.update: WorkforceEventUpdate
Field	Type	Required	Description
event_kind	"Briefing" \| "Crew Call" \| "Meeting"	No	Event kind.
title	string	No	Event title.Constraints: length 1 to 200
agenda	string \| null	No	Agenda, in order.Constraints: length 1 to 20000
location	string \| null	No	Where to meet.Constraints: length 1 to 300
venue_id	string (uuid) \| null	No	Identifier of the venue.
space_id	string (uuid) \| null	No	Identifier of the space within the venue.
project_id	string (uuid) \| null	No	Identifier of the project audience, or the project the row belongs to.
starts_at	string (date-time)	No	Start.
ends_at	string (date-time)	No	End, at most seven days after the start.
rsvp_required	boolean	No	Whether invitees are asked to RSVP.

{
  "event_kind": "Briefing",
  "title": "Load-in crew call",
  "agenda": "1. Safety brief. 2. Assignments.",
  "location": "Dock door 3",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "space_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "starts_at": "2026-10-08T14:30:00Z",
  "ends_at": "2026-10-08T14:30:00Z",
  "rsvp_required": true
}

Response 200: WorkforceEvent

workforceEvents.update: WorkforceEvent
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the workforce event.
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	Person who created the row; null for seed, platform or system writes.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Person who last updated the row; null for seed, platform or system writes.
event_kind	"Briefing" \| "Crew Call" \| "Meeting"	Yes	Event kind.
title	string	Yes	Event title.Constraints: length 1 to 200
agenda	string \| null	Yes	Agenda, in order.Constraints: length 1 to 20000
location	string \| null	Yes	Where to meet.Constraints: length 1 to 300
venue_id	string (uuid) \| null	Yes	Identifier of the venue.
space_id	string (uuid) \| null	Yes	Identifier of the space within the venue.
audience_kind	"Organization" \| "Project" \| "Team" \| "Department" \| "Role" \| "Group"	Yes	Who the row reaches. Department (a canon department, 1365) is for feed posts only.
project_id	string (uuid) \| null	Yes	Identifier of the project audience, or the project the row belongs to.
team_id	string (uuid) \| null	Yes	Identifier of the team audience.
role_id	string (uuid) \| null	Yes	Identifier of the org role audience.
group_id	string (uuid) \| null	Yes	Identifier of the group audience, including department groups.
organizer_membership_id	string (uuid) \| null	Yes	Identifier of the member who organizes the event.
starts_at	string (date-time)	Yes	Start.
ends_at	string (date-time)	Yes	End, at most seven days after the start.
rsvp_required	boolean	Yes	Whether invitees are asked to RSVP.
canceled_at	string (date-time) \| null	Yes	When the event was canceled.
cancel_reason	string \| null	Yes	Why it was canceled.Constraints: length 1 to 500

{
  "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",
  "event_kind": "Briefing",
  "title": "Load-in crew call",
  "agenda": "1. Safety brief. 2. Assignments.",
  "location": "Dock door 3",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "space_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "audience_kind": "Organization",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "group_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "organizer_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "starts_at": "2026-10-08T14:30:00Z",
  "ends_at": "2026-10-08T14:30:00Z",
  "rsvp_required": true,
  "canceled_at": "2026-10-08T14:30:00Z",
  "cancel_reason": "Dock closed for repairs."
}

Code samples

curl -X PATCH "$XOS_BASE_URL/workforce-events/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 '{"event_kind":"Briefing","title":"Load-in crew call","agenda":"1. Safety brief. 2. Assignments.","location":"Dock door 3","venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","space_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","starts_at":"2026-10-08T14:30:00Z","ends_at":"2026-10-08T14:30:00Z","rsvp_required":true}'

const { data, etag } = await xos.workforceEvents.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "event_kind": "Briefing",
    "title": "Load-in crew call",
    "agenda": "1. Safety brief. 2. Assignments.",
    "location": "Dock door 3",
    "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "space_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "starts_at": "2026-10-08T14:30:00Z",
    "ends_at": "2026-10-08T14:30:00Z",
    "rsvp_required": true
  }, { ifMatch: etag });

response = xos.workforce_events.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"event_kind": "Briefing", "title": "Load-in crew call", "agenda": "1. Safety brief. 2. Assignments.", "location": "Dock door 3", "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "space_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "starts_at": "2026-10-08T14:30:00Z", "ends_at": "2026-10-08T14:30:00Z", "rsvp_required": True}, if_match=etag)

xos workforce-events update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"event_kind":"Briefing","title":"Load-in crew call","agenda":"1. Safety brief. 2. Assignments.","location":"Dock door 3","venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","space_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","starts_at":"2026-10-08T14:30:00Z","ends_at":"2026-10-08T14:30:00Z","rsvp_required":true}' --if-match auto