FabricSubscribers

Create Subscriber

View as Markdown

Create a new Subscriber

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.
emailstringRequired
Email of the Subscriber.
passwordstringOptional8-72 characters
Password of the Subscriber. Defaults to a secure random password if not provided.
first_namestringOptional
First name of the Subscriber.
last_namestringOptional
Last name of the Subscriber.
display_namestringOptional
Display name of the Subscriber.
job_titlestringOptional
Job title of the Subscriber.
timezonestringOptional
Timezone of the Subscriber.
countrystringOptional
Country of the Subscriber.
regionstringOptional
Region of the Subscriber.
company_namestringOptional
Company name of the Subscriber.

Response

The request has succeeded and a new resource has been created as a result.
idstring
Unique ID of the request.
project_idstring
Unique ID of the project.
display_namestring
Display name of the Subscriber.
typeenum
Type of the resource.
Allowed values:
created_atdatetime
Date and time when the resource was created.
updated_atdatetime
Date and time when the resource was updated.
subscriberobject
Subscriber data.

Errors