---
title: "PATCH /phone/numbers/{phoneIdentityId}"
method: PATCH
path: "/phone/numbers/{phoneIdentityId}"
---

# PATCH /phone/numbers/{phoneIdentityId}

`PATCH /phone/numbers/{phoneIdentityId}`

## Request

- Base URL: `https://api.useanima.sh/v1`
- URL: `https://api.useanima.sh/v1/phone/numbers/{phoneIdentityId}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

## Path parameters

- `phoneIdentityId` string, required: The number to update

## Request body

- object: Update one phone number's settings
  - `voiceId` string, nullable, required: Voice id from the catalog, or null to fall back to the agent's voice. Rejected if the id is not in the catalog.

## Response `200`

OK

- object: Phone identity associated with an agent
  - `id` string, required: Unique identifier of the phone identity
  - `phoneNumber` string, required: Phone number in E.164 format
  - `providerId` string, nullable, required: Opaque carrier-side identifier for this phone number
  - `capabilities` object, required: Communication capabilities supported by this phone number
    - `sms` boolean: Whether the number supports SMS messaging
    - `mms` boolean: Whether the number supports MMS messaging
    - `voice` boolean: Whether the number supports voice calls
  - `tenDlcStatus` 'PENDING' | 'REGISTERED' | 'REJECTED' | 'NOT_REQUIRED' | 'UNREGISTERED', required: 10DLC campaign registration status
  - `isPrimary` boolean, required: Whether this is the agent's primary phone identity
  - `voiceId` string, nullable, required: The voice this number answers with, from the voice catalog. Null means it uses the agent's voice, and then the system default. Set it per number so one agent's support line and sales line can sound different.
  - `createdAt` string, date-time, required: Timestamp when the phone identity was created

---

[API](https://skmtc.dev/useanima/apis/anima-api.md) · [All operations](https://skmtc.dev/useanima/apis/anima-api/llms.txt) · [OpenAPI document](https://skmtc.dev/useanima/apis/anima-api/revisions/aaa148188980?raw)