Skip to main content
POST
cURL
The failover configuration lets you set up this number to act as a failover target..
  • Set enabled to true to activate failover.
  • The mode can be either all (any number can fail over) or selective (only specific numbers are allowed. Useful for multi-tenant failover setups).
  • If you’re using selective mode, provide the list of allowed leased numbers in numbers.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

number
string
required

Phone number in E.164 format

Example:

"+13059478667"

Body

application/json
failover
object

Response

Configure a leased number (failover, etc.)

id
string
required
Example:

"req_xxxxxxxxxxxxxxxx"

timestamp
number
required
Example:

1772568052124

api_version
string
required
Example:

"v2026.3.3"

object
string
required
Example:

"response"

data
object
required