Skip to navigation
Resource ManagementAlias Addresses

Update alias address

View as MarkdownOpen in Claude

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.

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 an alias address.

Request

This endpoint expects an object.
namestringOptionalformat: "^[a-z0-9_-]+$"<=256 characters

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_namestringOptional

Human-friendly label for the alias.

channelslist of enumsOptional
Channels to enable on the alias. At least one is required.
Allowed values:
codecslist of enumsOptional
Codecs to enable for calls to the alias.
contextenumOptional

Access context to move the alias to. Only changed when supplied; otherwise the alias stays in its current context.

Allowed values:

Response

The request has succeeded.
idstringformat: "uuid"
Unique identifier for the alias address.
typeenum

The object type. Always alias.

Allowed values:
resource_idstringformat: "uuid"
ID of the resource that handles calls and messages to this alias.
namestring

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

display_namestring

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

display_typeenum
Display type derived from the handler resource. Returned for reference only and cannot be set.
Allowed values:
channelslist of enums
Channels enabled on this alias.
Allowed values:
codecslist of enums
Codecs enabled for calls to this alias. Empty when none are set.
contextenum
Access context the alias lives in.
Allowed values:
uristring

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

created_atdatetime
Date and time when the alias address was created.
updated_atdatetime
Date and time when the alias address was last updated.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error