Organization Invitations

Revoke a pending organization invitation

Changed on

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.

post/organizations/{organization_id}/invitations/{invitation_id}/revoke

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/organizations/{organization_id}/invitations/{invitation_id}/revoke
  • Auth: HTTP bearer

Path parameters

organization_idstring required

The organization ID.

invitation_idstring required

The organization invitation ID.

Request body

requesting_user_idstring nullable

The ID of the user that revokes the invitation. Must be an administrator in the organization.

Response

An organization invitation

object'organization_invitation' required

String representing the object's type. Objects of the same type share the same value.

idstring required
email_addressstring required
rolestring required
role_namestring required
organization_idstring
inviter_idstring nullable required
statusstring
public_metadataobject required
private_metadataobject
urlstring nullable required
expires_atinteger nullable required

Unix timestamp of expiration.

created_atinteger required

Unix timestamp of creation.

updated_atinteger required

Unix timestamp of last update.

Changes