Revoke Invitation

POST

/v1/invitations/{invitation_id}/revoke

Revoke a pending invitation. No-ops if already accepted or expired. The invited user’s link will immediately stop working. Tenant admin only.

Parameters

Path Parameters

invitation_id

required

Invitation Id

string

Request Body ^required

InvitationRevokeRequest

Optional request body for revocation (reserved for future reason field).

object

reason

Any of:

string

string

<= 500 characters

null

null

Responses

200

Successful Response

InvitationRead

Projection of a WorkOS invitation object.

object

id

required

Id

string

email

required

Email

string

state

required

State

string

role_slug

Any of:

string

string

null

null

organization_id

Any of:

string

string

null

null

created_at

Any of:

string

string format: date-time

null

null

expires_at

Any of:

string

string format: date-time

null

null

accepted_at

Any of:

string

string format: date-time

null

null

revoked_at

Any of:

string

string format: date-time

null

null

inviter_user_id

Any of:

string

string

null

null

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object