Skip to content

Create a caller-ID pool

POST
/v1/number-pools
curl --request POST \
--url https://api.vocapable.com/v1/number-pools \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "rotation_strategy": "round_robin" }'
Media typeapplication/json
NumberPoolCreateRequest
object
name
required
Name
string
>= 1 characters <= 200 characters
rotation_strategy
Rotation Strategy
string
default: round_robin
Allowed value: round_robin

Successful Response

Media typeapplication/json
NumberPoolSummary
object
id
required
Id
string
name
required
Name
string
rotation_strategy
required
Rotation Strategy
string
Allowed value: round_robin
created_at
required
Created At
string format: date-time
Example
{
"rotation_strategy": "round_robin"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}