Skip to main content
POST
Invite a member by email

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

organizationId
string
required
Minimum string length: 1

Body

application/json
email
string<email>
required
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
role
enum<string>
default:full_editor
Available options:
admin,
full_editor,
content_editor
expiresAt
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
resend
boolean
callbackUrl
string<uri>
sendEmail
boolean

Whether to email the recipient an acceptance link. Defaults to true; pass false to create the invitation silently and deliver the returned url yourself.

Response

The created invitation with its acceptance URL.

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.

url
string
required

Acceptance URL for the invited email. Anyone signed in with that verified email can accept through it.