Sign in
Alias Addresses

Update alias address

Partially updates an alias address by ID; omitted fields keep their current values. Use it to rename the alias, change its display name, channels, or codecs, or move it between the public and private contexts. resource_id isn't accepted: to point an alias at a different resource, delete it and create a new one. An ID that belongs to a different kind of address, such as a SIP address, returns a 404.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Calling, Fax, Messaging, or Video.

Learn more about API scopes.

patch/api/fabric/alias_addresses/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of an alias address.

Request body

namestring

URL-safe name for the alias — lowercase letters and numbers, with underscores or dashes in place of spaces. Dashes can't start or end the name or appear twice in a row. Must be unique within its context. Keeps the current value when omitted.

display_namestring

Human-friendly label for the alias.

channelsAliasAddressChannel[]

Channels to enable on the alias. At least one is required.

codecsAddressCodec[]

Codecs to enable for calls to the alias.

context'public' | 'private'

Access context an alias address lives in.

Example request

{
  "name": "customer-support",
  "display_name": "Customer Support",
  "channels": [
    "audio",
    "messaging",
    "video"
  ],
  "codecs": [
    "OPUS"
  ]
}

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

type'alias' required

The object type. Always alias.

resource_idstring uuid required

Universal Unique Identifier.

namestring required

URL-safe name for the alias. Used to build its address.

display_namestring required

Human-friendly label for the alias. Defaults to name.

display_type'app' | 'room' | 'call' | 'subscriber' required

DisplayTypes

channelsAliasAddressChannel[] required

Channels enabled on this alias.

codecsAddressCodec[] required

Codecs enabled for calls to this alias. Empty when none are set.

context'public' | 'private' required

Access context an alias address lives in.

uristring required

The resource address this alias resolves to, in the form /<context>/<name>.

created_atstring date-time required

Date and time when the alias address was created.

updated_atstring date-time required

Date and time when the alias address was last updated.

Example response

{
  "type": "alias",
  "name": "support",
  "display_name": "Support Line",
  "channels": [
    "audio",
    "messaging",
    "video"
  ],
  "codecs": [],
  "uri": "/public/support",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z"
}

Changes

Changed in 1 of the 161 revisions of this API.1

Of the 161 revisions, 3 have a changelog that could not be searched.