POST /api/v2/numbers/swap
Swaps a target's primary number with a new one.
- If a specific number is provided (
type: 'provided_number'), the target’s primary number is swapped with that number. The provided number must be available in the company’s reserved pool, and thereserve_poolexperiment must be enabled for the company. - If an area code is provided (
type: 'area_code'), an available number from that area code is assigned. - If neither is provided (
type: 'auto'), a number is automatically assigned — first from the company’s reserved pool (if available), otherwise from the target’s office area code. If no type is specified, 'auto' is used by default.
Added on Mar 28, 2025 for API v2.
Rate limit: 1200 per minute.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
swap_details |
No |
Type of number swap (area_code, auto, provided_number). |
|
target |
Object | Yes | |
target.target_id |
Integer | Yes |
The ID of the target to swap number. |
target.target_type |
String | Yes |
The type of the target. Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.