POST
/organizations/{organization_id}/invitations/{invitation_id}/revokeRevoke a pending organization invitation
Use this request to revoke a previously issued organization invitation.
Revoking an organization invitation makes it invalid; the invited user will no longer be able to join the organization with the revoked invitation.
Only organization invitations with "pending" status can be revoked.
The request accepts the requesting_user_id parameter to specify the user which revokes the invitation.
Only users with "admin" role can revoke invitations.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
organization_idstringrequired
The organization ID.
invitation_idstringrequired
The organization invitation ID.
requesting_user_idstringoptional
The ID of the user that revokes the invitation.
Must be an administrator in the organization.
200An organization invitation
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
idstringrequired
email_addressstringrequired
rolestringrequired
role_namestringrequired
organization_idstringoptional
inviter_idstringrequired
public_inviter_dataobjectrequired
An organization inviter's public user data
statusstringoptional
public_metadataobjectrequired
private_metadataobjectoptional
urlstringrequired
expires_atintegerrequired
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
403Authorization invalid
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 403 is returned: Authorization invalid. A 404 is returned: Resource not found.