Docs
Sign in

Revoke a pending invitation.

id is Clerk's invitation id (inv_...).

POST/api/v1/invites/{id}/revoke

Scopeapprove

The sign-up link stops working. Clerk refuses an invitation that was accepted or already revoked, and that refusal is passed on as 502 clerk_error with Clerk's reason. Records invite.revoked with who revoked it. When an API key calls it, the timeline records who did what and the outcome. No query parameters, and no body.

Path parameters.

idstringrequired

The Clerk invitation's id.

Headers.

Idempotency-Keystring

Makes a retry safe: the same key with the same request returns the first answer and does nothing else.

Response.

200 OK: a JSON object. The example has placeholder values.