FabricSubscribers

Create Subscriber Token

View as Markdown

Create a Subscriber Token

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

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Request

This endpoint expects an object.
referencestringRequired
A string that uniquely identifies the subscriber. Often it's an email, but can be any other string.
expire_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’

application_idstringOptionalformat: "uuid"
The ID of the application that the token is associated with.
passwordstringOptional
Set or update the subscriber's password. Omit this field or pass an empty string if you don't want to update the password.
first_namestringOptional
Set or update the first name of the subscriber.
last_namestringOptional
Set or update the last name of the subscriber.
display_namestringOptional
Set or update the display name of the subscriber.
job_titlestringOptional
Set or update the job title of the subscriber.
time_zonestringOptional
Set or update the time zone of the subscriber.
countrystringOptional
Set or update the country of the subscriber.
regionstringOptional
Set or update the region of the subscriber.
company_namestringOptional
Set or update the company name of the subscriber.

Response

The request has succeeded.
subscriber_idstringformat: "uuid"
The ID of the subscriber that the token is associated with.
tokenstringformat: "jwt"
The token that is associated with the subscriber.
refresh_tokenstringformat: "jwt"
Refresh token.

Errors