---
title: "Update alias address"
method: PATCH
path: "/api/fabric/alias_addresses/{id}"
tags: ["Alias Addresses"]
---

# Update alias address

`PATCH /api/fabric/alias_addresses/{id}`

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](/docs/platform/your-signalwire-api-space).

## Path parameters

- `id` string, uuid, required — Universal Unique Identifier.

## Request body

- AliasAddressUpdateRequest
  - `name` string — 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_name` string — Human-friendly label for the alias.
  - `channels` AliasAddressChannel[] — Channels to enable on the alias. At least one is required.
  - `codecs` AddressCodec[] — Codecs to enable for calls to the alias.
  - `context` 'public' | 'private' — Access context an alias address lives in.

## Response `200`

The request has succeeded.

- AliasAddress
  - `id` string, uuid, required — Universal Unique Identifier.
  - `type` 'alias', required — The object type. Always `alias`.
  - `resource_id` string, uuid, required — Universal Unique Identifier.
  - `name` string, required — URL-safe name for the alias. Used to build its address.
  - `display_name` string, required — Human-friendly label for the alias. Defaults to `name`.
  - `display_type` 'app' | 'room' | 'call' | 'subscriber', required — DisplayTypes
  - `channels` AliasAddressChannel[], required — Channels enabled on this alias.
  - `codecs` AddressCodec[], required — Codecs enabled for calls to this alias. Empty when none are set.
  - `context` 'public' | 'private', required — Access context an alias address lives in.
  - `uri` string, required — The resource address this alias resolves to, in the form `/<context>/<name>`.
  - `created_at` string, date-time, required — Date and time when the alias address was created.
  - `updated_at` string, date-time, required — Date and time when the alias address was last updated.

## Other responses

- `400` — The request is invalid.
- `401` — Access is unauthorized.
- `404` — The server cannot find the requested resource.
- `422` — The request contains invalid parameters. See errors for details.
- `500` — An internal server error occurred.

## Changes

> 161 revisions in range; 3 could not be searched.

- **2026-09-15** `f0464a93a362` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/signalwire/apis/signalwire-rest-api/changes/api/fabric/alias_addresses/:id/patch.md)

---

[API](https://skmtc.dev/signalwire/apis/signalwire-rest-api.md) · [All operations](https://skmtc.dev/signalwire/apis/signalwire-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/signalwire/apis/signalwire-rest-api/revisions/20ee0f568ece?raw)