Revoke an Invite link

DELETE

/api/v1/auth/invites/{id}

curl --request DELETE \
  --url https://example.com/api/v1/auth/invites/example \
  --header 'Authorization: Bearer <token>'

Revokes an Invite link. It requires a signed-in User with the admin scope and the admin or owner Role. It also requires a recent passkey check. It can return 400 if the request is invalid, 401 if the session is missing or expired, 403 if access is denied and 429 if the request limit is reached. Route: /api/v1/auth/invites/{id}. Inputs: id. A recent account assertion is required. Do not automatically replay this operation after an uncertain result.

Authorizations

• installationBearer
• browserSession

Parameters

Path Parameters

id

required

string

Invite id from GET /auth/invites

Responses

204

400

Media typeapplication/json

object

code

required

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}

429

Too many requests

Media typeapplication/json

object

code

required

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}