Sign in

v22

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-01140308542.4 KB
Invitations

Create zone invitation

Creates a new invitation to join a zone and sends an email notification. Only available when the zone has no external identity provider configured.

post/zones/{zoneId}/invitations

Path parameters

zoneIdstring required

Zone ID

Request body

emailstring email required

Email address to send the invitation to

Response

A zone invitation sent to a user by email

idstring required

Unique identifier of the invitation

organization_idstring required

Organization that owns this invitation

zone_idstring required

Zone this invitation belongs to

emailstring email required

Email address the invitation was sent to

status'pending' | 'accepted' | 'expired' required

Status of a zone invitation

created_bystring required

ID of the user who created the invitation

created_by_emailstring email

Email address of the user who created the invitation

expires_atstring date-time required

Date when the invitation expires

last_sent_atstring date-time required

Date when the invitation email was last sent

created_atstring date-time required

Entity creation timestamp

updated_atstring date-time required

Entity update timestamp