Create Subscriber

POST

https://{your_space_name}.signalwire.com/api/fabric/resources/subscribers

POST

/api/fabric/resources/subscribers

curl -X POST https://{your_space_name}.signalwire.com/api/fabric/resources/subscribers \
     -H "Content-Type: application/json" \
     -u "<project_id>:<api_token>" \
     -d '{
  "email": "johndoe@example.com"
}'

{
  "id": "d369a402-7b43-4512-8735-9d5e1f387814",
  "project_id": "d369a402-7b43-4512-8735-9d5e1f387814",
  "display_name": "John Doe",
  "type": "subscriber",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "subscriber": {
    "id": "d369a402-7b43-4512-8735-9d5e1f387814",
    "email": "johndoe@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "display_name": "John Doe",
    "job_title": "Software Engineer",
    "timezone": "America/New_York",
    "country": "United States",
    "company_name": "SignalWire"
  }
}

Creates a Subscriber resource for a known user, with sign-in credentials and optional profile fields. Use it when the user needs a persistent identity for Browser SDK or resource access; use Create Subscriber guest token for temporary scoped access without a full account. Issue the new subscriber a client credential through Create 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.

Creates a [Subscriber](/docs/platform/subscribers) resource for a known user, with sign-in credentials and optional profile fields. Use it when the user needs a persistent identity for Browser SDK or resource access; use [Create Subscriber guest token](/docs/apis/rest/subscribers/tokens/create-subscriber-guest-token) for temporary scoped access without a full account. Issue the new subscriber a client credential through [Create Subscriber token](/docs/apis/rest/subscribers/tokens/create-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](/docs/platform/your-signalwire-api-space).

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)

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.

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.

created_atdatetime

Date and time when the resource was created.

updated_atdatetime

Date and time when the resource was updated.

subscriberobject

Subscriber data.

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error