Skip to navigation
Resource ManagementSubscribers

Update Subscriber

View as MarkdownOpen in Claude

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.

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)

Path parameters

idstringRequiredformat: "uuid"
Unique ID of a Subscriber.

Request

This endpoint expects an object.
passwordstringOptional8-72 characters
New password for the Subscriber. Omit to keep the current password.
emailstringOptional
Email of the Subscriber.
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.
time_zonestringOptional

Time zone of the Subscriber. Defaults to GMT if not provided.

countrystringOptional
Country of the Subscriber.
company_namestringOptional
Company name of the Subscriber.

Response

The request has succeeded.
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

422
Unprocessable Entity Error
500
Internal Server Error