REST ClientCompatAccounts

update

View as MarkdownOpen in Claude

Update an account. Uses POST (Twilio convention).

Path parameters

SidstringRequiredformat: "uuid"
The Project ID that uniquely identifies the Project to retrieve.

Request

FriendlyNamestringRequired<=250 characters
The new name for the Project.

Response

sidstringRequiredformat: "uuid"
The unique identifier for this Project.
friendly_namestringRequired
The name of the Project.
statusenumRequired
The status of the Project. Always 'active'.
auth_tokenstringRequired
The authorization token for this Project. Always returns 'redacted' for security.
date_createdstringRequired
The date and time this Project was created, in RFC 2822 format.
date_updatedstringRequired
The date and time this Project was last updated, in RFC 2822 format.
typeenumRequired
The type of the Project. Always 'Full'.
owner_account_sidstringRequiredformat: "uuid"
The Project ID of the parent project. For parent projects, this is the same as sid.
region_preferencestringRequired
The preferred region for the Project.
uristringRequired
The URI for the Project.
subprojectbooleanRequired
Whether this project is a sub-project of another project.
signing_keystring or nullRequired
The signing key for the Project. Only returned once when a subproject is created. Subsequent requests return null.
subresource_urisobjectRequired
A map of URIs for sub-resources linked to this Project.

Response Example

Response
{
  "sid": "b3877c40-da60-4998-90ad-b792e98472af",
  "friendly_name": "My Project",
  "status": "active",
  "auth_token": "redacted",
  "date_created": "Sat, 15 Sep 2018 10:00:00 +0000",
  "date_updated": "Sat, 16 Sep 2018 10:00:00 +0000",
  "type": "Full",
  "owner_account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
  "region_preference": "us-east",
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af",
  "subproject": false,
  "signing_key": null,
  "subresource_uris": {
    "addresses": null,
    "available_phone_numbers": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers",
    "applications": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications",
    "authorized_connect_apps": null,
    "calls": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls",
    "conferences": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences",
    "connect_apps": null,
    "incoming_phone_numbers": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/IncomingPhoneNumbers",
    "keys": null,
    "notifications": null,
    "outgoing_caller_ids": null,
    "queues": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues",
    "recordings": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Recordings",
    "sandbox": null,
    "sip": null,
    "short_codes": null,
    "messages": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Messages",
    "transcriptions": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Transcriptions",
    "usage": null
  }
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com",
});
await client.compat.accounts.update("account-sid", { FriendlyName: "Sales Team" });