Organizations

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.

post/organizations/{organizationId}/invitations

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/organizations/{organizationId}/invitations
  • Auth: HTTP bearer

Path parameters

organizationIdstring required

Request body

emailstring email required
role'admin' | 'full_editor' | 'content_editor'
resendboolean
callbackUrlstring uri
sendEmailboolean

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.

idstring required

Unique invitation ID.

emailstring required

Invited email address, normalized to lowercase.

role'admin' | 'full_editor' | 'content_editor' required

Organization role granted on acceptance. owner is never invitable.

status'pending' | 'accepted' | 'rejected' | 'canceled' required

Lifecycle status. Only pending invitations can be accepted.

expiresAtstring date-time required

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

createdAtstring date-time required

When the invitation was created.

urlstring required

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

Changes

No recorded changes to this operation across all 1 revision of this API.