Skip to content

Delete an invite

Identity module

DELETE/invites/{id}invites.delete

An email invitation to join an org. Created through `invites.create` (the `app.invite_member` RPC); the token is never stored or returned again. Soft-deletes the invite: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability org.members.invite.
  • OAuth scopes: org.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

invites.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the invite.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/invites/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.invites.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.invites.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos invites delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f