---
title: "Enable/Disable Route CallerID"
method: PUT
path: "/{sub_domain}/api/route-caller-ids"
tags: ["Route-Caller-IDs"]
---

# Enable/Disable Route CallerID

`PUT /{sub_domain}/api/route-caller-ids`

## Request

- Base URL: `https://api.commpeak.com/pbx`
- URL: `https://api.commpeak.com/pbx/{sub_domain}/api/route-caller-ids`
- Auth: API key in header `Authorization`

Enables or disables an existing route caller ID.

**Parameters.**

- `id` (integer, required): ID of the route caller ID to update.
- `action` (integer, required): `1` to enable, `0` to disable.

**Returns.** The updated record inside the `callerIds` envelope.

**Notes.** A caller ID that is in use as a user caller ID or as the last caller ID of an outbound route cannot be disabled until it is replaced.

**Example.**

```
PUT /api/route-caller-ids
{
  "id": 9,
  "action": 0
}
```

## Path parameters

- `sub_domain` string, required: PBX Name (subdomain)

## Request body

- UpdateRouteCallerIDInput
  - `id` string, required: ID of the route caller ID to update.
  - `action` string, required: Action to perform: 1 = enable, 0 = disable.

## Response `200`

Successful Response

- RouteCallerIDsResponse
  - `callerIds` RouteCallerIDItem[], required
    - `id` integer, nullable: Route caller ID.
    - `caller_id_name` string, nullable: Caller ID name.
    - `caller_id_number` string, nullable: Caller ID number.
    - `created_at` string, nullable: Creation timestamp.
    - `is_active` integer, nullable: Enabled flag: 1 = active, 0 = disabled.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/commpeak/apis/commpeak-pbx-api.md) - [All operations](https://skmtc.dev/commpeak/apis/commpeak-pbx-api/llms.txt) - [OpenAPI document](https://skmtc.dev/commpeak/apis/commpeak-pbx-api/revisions/0b1e8c7fd3f6?raw)