Dialpad Number -- 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 the reserve_pool experiment 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.

Rate limit: 1200 per minute.

Body Params
swap_details

Type of number swap (area_code, auto, provided_number).

target
object
required

The target for swap number.

Response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json