Create Subscriber

POST 
/resources/subscribers

Create Subscriber

Request

application/json

Body

required

password stringrequired

Possible values: >= 8 characters and <= 72 characters

Password of the Subscriber.

email stringrequired

Email of the Subscriber.

first_name string

First name of the Subscriber.

last_name string

Last name of the Subscriber.

display_name string

Display name of the Subscriber.

job_title string

Job title of the Subscriber.

timezone string

Timezone of the Subscriber.

country string

Country of the Subscriber.

region string

Region of the Subscriber.

company_name string

Company name of the Subscriber.

Responses

201

The request has succeeded and a new resource has been created as a result.

application/json

Schema

Schema

id stringrequired

Unique ID of the request.

project_id stringrequired

Unique ID of the project.

display_name stringrequired

Display name of the Subscriber.

type stringrequired

Possible values: [subscriber]

Type of the resource.

created_at date-timerequired

Date and time when the resource was created.

updated_at date-timerequired

Date and time when the resource was updated.

subscriber

object

required

id stringrequired

Unique ID of the Subscriber.

email stringrequired

Email of the Subscriber.

first_name stringrequired

First name of the Subscriber.

last_name stringrequired

Last name of the Subscriber.

display_name stringrequired

Display name of the Subscriber.

job_title stringrequired

Job title of the Subscriber.

timezone stringrequired

Timezone of the Subscriber.

country stringrequired

Country of the Subscriber.

region stringrequired

Region of the Subscriber.

company_name stringrequired

Company name of the Subscriber.

Example (from schema)

{
  "id": "d369a402-7b43-4512-8735-9d5e1f387814",
  "project_id": "d369a402-7b43-4512-8735-9d5e1f387814",
  "display_name": "John Doe",
  "type": "subscriber",
  "created_at": "2024-10-17T14:14:53Z",
  "updated_at": "2024-10-17T14:14:53Z",
  "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",
    "region": "New York",
    "company_name": "SignalWire"
  }
}

401

Access is unauthorized.

application/json

Schema

Schema

string

Possible values: [Unauthorized]

404

The server cannot find the requested resource.

application/json

Schema

Schema

string

Possible values: [Not Found]

422

Client error

application/json

Schema

Schema

errors

object[]

required

Array [

type stringrequired

Error type.

code stringrequired

Error code.

message stringrequired

Error details.

attribute stringrequired

Request parameter associated with this error.

url stringrequired

Link to developer resource for this error.

]

Example (from schema)

{
  "errors": [
    {
      "type": "validation_error",
      "code": "missing_required_parameter",
      "message": "Required parameter is missing",
      "attribute": "password",
      "url": "https://developer.signalwire.com/rest/signalwire-rest/overview/error-codes#invalid_parameter"
    }
  ]
}

Loading...