RSVP to an event
Módulo Workforce
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`.
- Requiere la capacidad schedule.timeline.read.
- Alcances de OAuth: schedule.
- Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
- Estados de error: 400, 401, 404, 409, 422, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the workforce event. |
Cuerpo de la solicitud: RsvpRequest
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| response | "Going" | "Maybe" | "Declined" | Sí | Answer. |
{
"response": "Going"
}Respuesta 200: EventRsvp
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the event rsvp. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Person who last updated the row; null for seed, platform or system writes. |
| workforce_event_id | string (uuid) | Sí | Identifier of the event. |
| membership_id | string (uuid) | Sí | Identifier of the invitee. |
| response | "Going" | "Maybe" | "Declined" | Sí | RSVP answer. |
| responded_at | string (date-time) | Sí | When 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"
}Ejemplos de código
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"}'