Skip to main content
POST
Cancel a pending invitation

Authorizations

Authorization
string
header
required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Path Parameters

invitationId
string
required
Minimum string length: 1

Response

The invitation that was canceled.

id
string
required

Unique invitation ID.

email
string
required

Invited email address, normalized to lowercase.

role
enum<string>
required

Organization role granted on acceptance. owner is never invitable.

Available options:
admin,
full_editor,
content_editor
status
enum<string>
required

Lifecycle status. Only pending invitations can be accepted.

Available options:
pending,
accepted,
rejected,
canceled
expiresAt
string<date-time>
required

When the invitation stops being acceptable (48 hours after creation by default).

createdAt
string<date-time>
required

When the invitation was created.

organizationId
string
required

Organization the invitation belonged to.