Update Subscriber

PUT 
/resources/subscribers/:id

Updates a Subscriber by ID.

Request

Path Parameters

id uuidrequired

The ID of the Subscriber

application/json

Body

required

email email
first_name string
last_name string
display_name string
job_title string
time_zone string
country string
region string
company_name string
password string

Responses

200

A Subscriber

application/json

Schema

Schema

id uuid
project_id uuid
display_name string
type string
created_at date-time
updated_at date-time

subscriber

object

id uuid

A unique identifier for the Subscriber

email email

first_name string

last_name string

display_name string

job_title string

time_zone string

country string

region string

company_name string

Example (from schema)

{
  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
  "display_name": "Reception",
  "type": "subscriber",
  "created_at": "2024-01-02T00:00:00Z",
  "updated_at": "2024-01-02T00:00:00Z",
  "subscriber": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "email": "user@example.com",
    "first_name": "string",
    "last_name": "string",
    "display_name": "string",
    "job_title": "string",
    "time_zone": "America/New_York",
    "country": "United States",
    "region": "Texas",
    "company_name": "string"
  }
}

422

Unprocessable Entity

application/json

Schema

Schema

type stringrequired
code stringrequired
message stringrequired
attribute string
url urirequired

Example (from schema)

{
  "type": "validation_error",
  "code": "invalid_parameter",
  "message": "Name must be present",
  "attribute": "name",
  "url": "https://developer.signalwire.com/rest/signalwire-rest/overview/error-codes#invalid_parameter"
}

Loading...