REST ClientFabricSubscribers

updateSipEndpoint

View as MarkdownOpen in Claude

Partially update a SIP endpoint for a subscriber. Uses PATCH, so only provided fields are changed.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of a Sip Endpoint.
fabric_subscriber_idstringRequiredformat: "uuid"
Unique ID of a Fabric Subscriber.

Request

usernamestringOptional
Username of the Sip Endpoint.
passwordstringOptional
Password of the Sip Endpoint.
caller_idstringOptional
Caller ID of the Sip Endpoint.
send_asstringOptional
The Number to send as.
cipherslist of enumsOptional
Ciphers of the Sip Endpoint.
Allowed values:
codecslist of enumsOptional
Codecs of the Sip Endpoint.
encryptionenumOptional
Encryption requirement of the Sip Endpoint.
Allowed values:

Response

idstringRequiredformat: "uuid"
Unique ID of the Sip Endpoint.
usernamestringRequired
Username of the Sip Endpoint.
caller_idstringRequired
Caller ID of the Sip Endpoint.
send_asstringRequired
Purchased or verified number
cipherslist of enumsRequired
Ciphers of the Sip Endpoint.
Allowed values:
codecslist of enumsRequired
Codecs of the Sip Endpoint.
encryptionenumRequired
Encryption requirement of the Sip Endpoint.
Allowed values:

Response Example

Response
1{
2  "id": "acaa5c49-be5e-4477-bce0-48f4b23b7720",
3  "username": "justice-league",
4  "caller_id": "call-id-123",
5  "send_as": "+14632322867",
6  "ciphers": [
7    "AEAD_AES_256_GCM_8"
8  ],
9  "codecs": [
10    "PCMU"
11  ],
12  "encryption": "optional"
13}

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.updateSipEndpoint(
10  "subscriber-id",
11  "endpoint-id",
12  { username: "new-username" }
13);
14console.log("Updated:", updated.username);