Offboard a member
Módulo Identity
POST/memberships/{id}/offboardmemberships.offboard
Ends access at once and opens the offboarding checklist. A sole Owner cannot remove or demote themselves. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requiere la capacidad org.members.manage.
- Alcances de OAuth: org.
- 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 membership. |
Respuesta 200: Membership
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the membership. |
| 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í | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| person_id | string (uuid) | Sí | Identifier of the member. |
| valid_from | string (date-time) | Sí | Start of membership. |
| valid_to | string (date-time) | null | Sí | End of membership. |
{
"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",
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"valid_from": "2026-10-08T14:30:00Z",
"valid_to": "2026-10-08T14:30:00Z"
}Ejemplos de código
curl -X POST "$XOS_BASE_URL/memberships/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/offboard" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.memberships.offboard("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.memberships.offboard("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos memberships offboard 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f