Sign in
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

Changes

Changed in 4 of the 23 revisions of this API.17

  • d65d51379d933See the full diff
    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 409

      response-non-success-status-added

  • 2abdf2efe2e61See the full diff
    • ▲

      the response property last_sent_at became nullable for the status 201

      response-property-became-nullable

  • d3d69f45bfed3See the full diff
    • ○

      the endpoint scheme security OAuth2 was added to the API

      api-security-added

    • ○

      the endpoint scheme security bearerAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security iam_bearerAuth was removed from the API

      api-security-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • cb43483cd1b31See the full diff
    • ○

      endpoint added

      endpoint-added