Skip to content

RSVP to an event

Workforce module

POST/workforce-events/{id}/rsvpworkforceEvents.rsvp

Records or changes the caller's RSVP. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requires the capability schedule.timeline.read.
  • OAuth scopes: schedule.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

workforceEvents.rsvp: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the workforce event.

Request body: RsvpRequest

workforceEvents.rsvp: RsvpRequest
FieldTypeRequiredDescription
response"Going" | "Maybe" | "Declined"YesAnswer.
{
  "response": "Going"
}

Response 200: EventRsvp

workforceEvents.rsvp: EventRsvp
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the event rsvp.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesPerson who last updated the row; null for seed, platform or system writes.
workforce_event_idstring (uuid)YesIdentifier of the event.
membership_idstring (uuid)YesIdentifier of the invitee.
response"Going" | "Maybe" | "Declined"YesRSVP answer.
responded_atstring (date-time)YesWhen they last answered.
{
  "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",
  "workforce_event_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "response": "Going",
  "responded_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X POST "$XOS_BASE_URL/workforce-events/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/rsvp" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"response":"Going"}'
const { data } = await xos.workforceEvents.rsvp("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "response": "Going"
  });
response = xos.workforce_events.rsvp("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"response": "Going"})
xos workforce-events rsvp 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"response":"Going"}'