For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
  • Datasphere
  • Logs
  • Messaging
  • Phone Number Management
  • Platform
  • Resource Management
      • POSTCreate Subscriber
      • DELDelete Subscriber
      • GETGet Subscriber
      • GETList Subscriber Addresses
      • GETList Subscribers
      • PUTUpdate Subscriber
LogoLogoSignalWire Docs
Log inSign up
Support
Resource ManagementSubscribers

Create Subscriber

|View as Markdown|Open in Claude|
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"
>}'
1{
2  "id": "d369a402-7b43-4512-8735-9d5e1f387814",
3  "project_id": "d369a402-7b43-4512-8735-9d5e1f387814",
4  "display_name": "John Doe",
5  "type": "subscriber",
6  "created_at": "2024-05-06T12:20:00Z",
7  "updated_at": "2024-05-06T12:20:00Z",
8  "subscriber": {
9    "id": "d369a402-7b43-4512-8735-9d5e1f387814",
10    "email": "johndoe@example.com",
11    "first_name": "John",
12    "last_name": "Doe",
13    "display_name": "John Doe",
14    "job_title": "Software Engineer",
15    "timezone": "America/New_York",
16    "country": "United States",
17    "company_name": "SignalWire"
18  }
19}
Create a new [Subscriber](/docs/platform/subscribers). #### 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).
Was this page helpful?
Previous

Delete Subscriber

Next
Built with

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.
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

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

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)