Revoke an invitation link
Identity module
POST/invitation-links/{id}/revokeinvitationLinks.revoke
Revokes the link; later uses are refused. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requires the capability org.members.invite.
- OAuth scopes: org.
- 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
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the invitation link. |
Response 200: InvitationLink
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the invitation link. |
| 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 | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| role | OrgRole | null | Yes | |
| expires_at | string (date-time) | Yes | When the link expires. |
| max_uses | integer | null | Yes | Maximum uses.Constraints: range 1 to any |
| revoked_at | string (date-time) | null | Yes | When the link was revoked. |
{
"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",
"role": "Manager",
"expires_at": "2026-10-08T14:30:00Z",
"max_uses": 10,
"revoked_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X POST "$XOS_BASE_URL/invitation-links/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/revoke" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.invitationLinks.revoke("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.invitation_links.revoke("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos invitation-links revoke 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f