> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.rydhm.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.rydhm.ai/_mcp/server.

# Create a number pool

POST https://api.rydhm.ai/v1/number-pools
Content-Type: application/json

Put numbers in it in the app (Phone numbers), or with `PATCH /v1/phone-numbers/{id}` from a session. A key limited to some experts cannot manage pools.

Sessions: admins.

Needs the calls:write scope. A key without it gets 403 insufficient\_scope. Routes not in this reference cannot be called with a key at all (403 not\_available\_to\_api\_keys).

Reference: https://docs.rydhm.ai/api-reference/rep-calls/create

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Body (application/json)

This endpoint expects a NumberPoolWrite.

- `name` (string, optional)
- `strategy` (enum, optional) — `local_presence`: a number in the callee’s area code first, then their state.
  - Allowed values: `round_robin`, `local_presence`
- `dailyCapPerNumber` (integer, optional) — Calls per number per day. Default 80.
- `callbackRouting` (CallbackRouting, optional) — Where a call back to a pool number rings, in order: the rep’s browser, their mobile, an expert, voicemail.

## Response

### 201

OK

- `id` (string, required) — A UUID.
- `name` (string, required)
- `strategy` (enum, required)
  - Allowed values: `round_robin`, `local_presence`
- `dailyCapPerNumber` (integer, required)
- `callbackRouting` (CallbackRouting, required) — Where a call back to a pool number rings, in order: the rep’s browser, their mobile, an expert, voicemail.
- `numbers` (list of NumberPoolNumbersItems, required)
- `createdAt` (datetime, required)

## Errors

### 401 Unauthorized Error

The key is missing, not valid, disabled or expired (error: invalid_api_key, api_key_disabled, api_key_expired).

- `statusCode` (integer, required)
- `message` (string, required)
- `error` (string, optional) — A stable code such as insufficient_scope, expert_not_allowed, rate_limited, plan_limit, payment_required.
- `code` (string, optional) — The stable code on the refusals that carry it here instead of in `error`: stale_edit (409 on an expert save).
- `requestId` (string, optional) — The X-Request-Id of the call, to quote to support.
- `upgradeHint` (ErrorUpgradeHint, optional) — On 402 payment_required and 403 plan_limit: what fixes it.
- `requiredScopes` (list of string, optional) — On 403 insufficient_scope: what the route needs.
- `missingScopes` (list of string, optional)
- `retryAfterSeconds` (integer, optional) — On 429: how long to wait.
- `retryAt` (datetime, optional, nullable)
- `timeZone` (string, optional, nullable)
- `localTime` (string, optional, nullable)
- `state` (string, optional, nullable)
- `exceptionsAllowed` (boolean, optional) — On 400 outside_calling_hours: whether `callingHoursException` may be sent.

### 403 Forbidden Error

The key lacks a scope (insufficient_scope), may not use this expert (expert_not_allowed), or the route is session-only (not_available_to_api_keys).

- `statusCode` (integer, required)
- `message` (string, required)
- `error` (string, optional) — A stable code such as insufficient_scope, expert_not_allowed, rate_limited, plan_limit, payment_required.
- `code` (string, optional) — The stable code on the refusals that carry it here instead of in `error`: stale_edit (409 on an expert save).
- `requestId` (string, optional) — The X-Request-Id of the call, to quote to support.
- `upgradeHint` (ErrorUpgradeHint, optional) — On 402 payment_required and 403 plan_limit: what fixes it.
- `requiredScopes` (list of string, optional) — On 403 insufficient_scope: what the route needs.
- `missingScopes` (list of string, optional)
- `retryAfterSeconds` (integer, optional) — On 429: how long to wait.
- `retryAt` (datetime, optional, nullable)
- `timeZone` (string, optional, nullable)
- `localTime` (string, optional, nullable)
- `state` (string, optional, nullable)
- `exceptionsAllowed` (boolean, optional) — On 400 outside_calling_hours: whether `callingHoursException` may be sent.

### 429 Too Many Requests Error

Rate limited; wait Retry-After seconds.

- `statusCode` (integer, required)
- `message` (string, required)
- `error` (string, optional) — A stable code such as insufficient_scope, expert_not_allowed, rate_limited, plan_limit, payment_required.
- `code` (string, optional) — The stable code on the refusals that carry it here instead of in `error`: stale_edit (409 on an expert save).
- `requestId` (string, optional) — The X-Request-Id of the call, to quote to support.
- `upgradeHint` (ErrorUpgradeHint, optional) — On 402 payment_required and 403 plan_limit: what fixes it.
- `requiredScopes` (list of string, optional) — On 403 insufficient_scope: what the route needs.
- `missingScopes` (list of string, optional)
- `retryAfterSeconds` (integer, optional) — On 429: how long to wait.
- `retryAt` (datetime, optional, nullable)
- `timeZone` (string, optional, nullable)
- `localTime` (string, optional, nullable)
- `state` (string, optional, nullable)
- `exceptionsAllowed` (boolean, optional) — On 400 outside_calling_hours: whether `callingHoursException` may be sent.

## Types

### CallbackRouting

Where a call back to a pool number rings, in order: the rep’s browser, their mobile, an expert, voicemail.

- `order` (list of enum, optional)
  - Allowed values: `rep_browser`, `rep_mobile`, `expert`, `voicemail`
- `ringSeconds` (integer, optional)
- `expertId` (string, optional) — The expert at the `expert` step (required when the order has one).
- `unmatched` (enum, optional) — A caller no rep called from this pool: `expert` (default) is the number’s own expert; `any_online_rep` rings the rep online now (seen most recently), then the order above.
  - Allowed values: `expert`, `any_online_rep`

### NumberPoolNumbersItems

- `id` (string, optional) — A UUID.
- `e164` (string, optional)
- `display` (string, optional)
- `inboundMode` (enum, optional)
  - Allowed values: `expert`, `rep`
- `usedToday` (integer, optional) — Calls placed from it today (UTC).

### ErrorUpgradeHint

On 402 payment_required and 403 plan_limit: what fixes it.

- `action` (enum, optional)
  - Allowed values: `top_up`, `upgrade`, `contact`
- `planCode` (string, optional) — The smallest plan that allows it, when action is upgrade.
- `href` (string, optional) — Where to go in the app.

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "id": "string",
  "name": "string",
  "strategy": "round_robin",
  "dailyCapPerNumber": 1,
  "callbackRouting": {
    "order": [
      "rep_browser"
    ],
    "ringSeconds": 1,
    "expertId": "string",
    "unmatched": "expert"
  },
  "numbers": [
    {
      "id": "string",
      "e164": "string",
      "display": "string",
      "inboundMode": "expert",
      "usedToday": 1
    }
  ],
  "createdAt": "2024-01-15T09:30:00Z"
}
```

**SDK Code**

```python
import requests

url = "https://api.rydhm.ai/v1/number-pools"

payload = {}
headers = {
    "Authorization": "Bearer <apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.rydhm.ai/v1/number-pools';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```