Sign in
Subscriber Tokens

Create Subscriber invite token

Creates a temporary invitation token for a guest to reach one of the authenticated Subscriber's resource addresses. A subscriber client calls this operation with its Subscriber Access Token (SAT), then passes the returned invitation to the guest. Invitations expire after two hours by default.

Use Create Subscriber guest token when your server grants guest access with a project API token instead. This endpoint requires the subscriber's SAT, not project-level Basic authentication.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.

Learn more about API scopes.

post/api/fabric/subscriber/invites

Request body

address_idstring uuid required

Universal Unique Identifier.

expires_atinteger

A unixtime (the number of seconds since 1970-01-01 00:00:00) at which the token should no longer be valid. Defaults to 'two hours from now'

Example request

{
  "expires_at": 1725513600
}

Response

The request has succeeded and a new resource has been created as a result.

tokenstring jwt required

Changes

Changed in 1 of the 137 revisions of this API.1

Of the 137 revisions, 3 have a changelog that could not be searched.