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

# Create Route CallerID

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

## Request

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

Creates a new route caller ID.

**Parameters.**

- `caller_id_name` (string, required): Caller ID name. Alphanumeric.
- `caller_id_number` (string, required): Caller ID number. Digits, optionally prefixed with `+`, and the placeholders `X`, `Z`, `N`.
- `is_active` (integer, optional): Enabled flag, `1` = active, `0` = disabled. Defaults to `1`.

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

**Example.**

```
POST /api/route-caller-ids
{
  "caller_id_name": "sales",
  "caller_id_number": "12125551234",
  "is_active": 1
}
```

## Path parameters

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

## Request body

- CreateRouteCallerIDInput
  - `caller_id_name` string, required: Caller ID name. Alphanumeric.
  - `caller_id_number` string, required: Caller ID number. Digits, optionally prefixed with +, and the placeholders X, Z, N.
  - `is_active` string, nullable: Enabled flag: 1 = active, 0 = disabled. Optional, defaults to 1.

## Response `201`

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-dialer-api.md) - [All operations](https://skmtc.dev/commpeak/apis/commpeak-dialer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/commpeak/apis/commpeak-dialer-api/revisions/18c5edc07544?raw)