Invite a member by email
Creates an invitation and, by default, emails the recipient an acceptance link; pass sendEmail: false to skip the email and deliver the returned url through your own channel. The response always includes the acceptance url. Requires a role with member management (owner or admin). The invited role defaults to full_editor and cannot be owner; invitations expire after 48 hours unless a custom expiresAt is set. Returns 409 when a pending invitation already exists for the email (pass resend: true to cancel it and issue a new one) or when the email already belongs to an organization member. List pending invitations with organizations.invitations.list.
Authorizations
Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.
Path Parameters
1Body
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$admin, full_editor, content_editor ^(?:(?:\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))$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.
Unique invitation ID.
Invited email address, normalized to lowercase.
Organization role granted on acceptance. owner is never invitable.
admin, full_editor, content_editor Lifecycle status. Only pending invitations can be accepted.
pending, accepted, rejected, canceled When the invitation stops being acceptable (48 hours after creation by default).
When the invitation was created.
Acceptance URL for the invited email. Anyone signed in with that verified email can accept through it.