Skip to main content
POST
Reserve a batch of numbers from a filter

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
country
string
required

ISO 3166-1 alpha-2 country code.

Required string length: 2
quantity
integer
required
Required range: 1 <= x <= 1000
area_code
string

Optional area-code / prefix filter (2–5 digits).

number_type
enum<string>
default:local
Available options:
local,
mobile,
toll_free
name_pattern
string

Optional digit-only pattern to match within the number.

pattern_type
enum<string>
default:contains
Available options:
contains,
starts_with,
ends_with
capabilities
string

Comma-separated capability filter (e.g. sms,voice).

provider
enum<string>
Available options:
devotel,
telnyx,
didww
compliance_profile_id
string

Response

The created reservation with its held items (15-minute TTL).

data
object
meta
object