Skip to navigation

Create Subscriber invite token

View as MarkdownOpen in Claude

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.

Authentication

AuthorizationBearer

SignalWire Bearer Token Authentication for subscriber endpoints. The client sends HTTP requests with the Authorization header containing the word Bearer followed by a space and the subscriber token.

Example:

Authorization: Bearer <subscriber_token>

Request

This endpoint expects an object.
address_idstringRequiredformat: "uuid"
Unique ID of a Subscriber Address
expires_atintegerOptional

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’

Response

The request has succeeded and a new resource has been created as a result.
tokenstringformat: "jwt"
Invite Token

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error