Clerk API (unofficial showcase)
POST/invitations/{invitation_id}/revoke

Revokes an invitation

Revokes the given invitation. Revoking an invitation will prevent the user from using the invitation link that was sent to them. However, it doesn't prevent the user from signing up if they follow the sign up flow. Only active (i.e. non-revoked) invitations can be revoked.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
invitation_idstringrequired
The ID of the invitation to be revoked

3 status codes
200Success
objectstringrequired
Allowed:invitation
idstringrequired
email_addressstringrequired
public_metadataobjectrequired
revokedbooleanoptional
Allowed:true
statusstringrequired
Allowed:revoked
urlstringoptional
expires_atintegeroptional
Unix timestamp of expiration.
created_atintegerrequired
Unix timestamp of creation.
updated_atintegerrequired
Unix timestamp of last update.
400Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Resource not found
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 400 is returned: Request was not successful. A 404 is returned: Resource not found.