Sign in

v13

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-04237161688.6 KB
Invitations

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.

post/invitations/{invitation_id}/revoke

Path parameters

invitation_idstring required

The ID of the invitation to be revoked

Response

Success

object'invitation' required
idstring required
email_addressstring email required
public_metadataobject required
revokedtrue
status'revoked' required
urlstring
expires_atinteger nullable

Unix timestamp of expiration.

created_atinteger required

Unix timestamp of creation.

updated_atinteger required

Unix timestamp of last update.

Example response

{
  "revoked": true,
  "status": "revoked"
}