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.
Authentication
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
Request
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.
Human-friendly label for the alias.
Access context to move the alias to. Only changed when supplied; otherwise the alias stays in its current context.
Response
The object type. Always alias.
URL-safe name for the alias. Used to build its address.
Human-friendly label for the alias. Defaults to name.
Codecs enabled for calls to this alias, or null when none are set.
The resource address this alias resolves to, in the form /<context>/<name>.