Sign in
Subscribers

Update Subscriber

Changes the profile or sign-in information for a persistent Subscriber identity in the project. Use Create Subscriber token or the refresh operation to manage a client's time-limited access.

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.

put/api/fabric/resources/subscribers/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of a Subscriber.

Request body

passwordstring

Password of the Subscriber. Defaults to a secure random password if not provided.

emailstring required

Email of the Subscriber.

first_namestring

First name of the Subscriber.

last_namestring

Last name of the Subscriber.

display_namestring

Display name of the Subscriber.

job_titlestring

Job title of the Subscriber.

timezonestring

Timezone of the Subscriber.

countrystring

Country of the Subscriber.

company_namestring

Company name of the Subscriber.

Example request

{
  "password": "password123",
  "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"
}

Response

The request has succeeded.

idstring required

Unique ID of the request.

project_idstring required

Unique ID of the project.

display_namestring required

Display name of the Subscriber.

type'subscriber' required

Type of the resource.

created_atstring date-time required

Date and time when the resource was created.

updated_atstring date-time required

Date and time when the resource was updated.

Example response

{
  "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": {
    "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"
  }
}

Changes

No changes found, but 3 of the 137 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.