REST ClientFabricSubscribers

update

View as MarkdownOpen in Claude

Replace a subscriber resource. Uses PUT, so the full resource body must be provided.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of a Subscriber.

Request

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.
regionstringOptional
Region of the Subscriber.
company_namestringOptional
Company name of the Subscriber.

Response

idstringRequired
Unique ID of the request.
project_idstringRequired
Unique ID of the project.
display_namestringRequired
Display name of the Subscriber.
typeenumRequired
Type of the resource.
Allowed values:
created_atdatetimeRequired
Date and time when the resource was created.
updated_atdatetimeRequired
Date and time when the resource was updated.
subscriberobjectRequired
Subscriber data.

Response Example

Response
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    "region": "New York",
18    "company_name": "SignalWire"
19  }
20}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com"
7});
8
9const updated = await client.fabric.subscribers.update("subscriber-id", {
10  name: "bob"
11});
12console.log("Updated:", updated.display_name);