Skip to main content
POST
Add Phone Number

Authorizations

x-api-key
string
header
required

API key for authentication. Generate API keys from the RevRing dashboard. A key is either full access or read-only; a read-only key is refused with 403 read_only_key on any request that creates, changes or deletes.

Path Parameters

id
string<uuid>
required

Agent ID

Body

application/json
e164
string
required

Phone number in E.164 format

Pattern: ^\+[1-9]\d{1,14}$
environment
string | null

Environment to bind the number to. Omit for production. Must exist on the agent (400 environment_not_found otherwise)

Pattern: ^[a-z][a-z0-9-]{0,31}$
trafficSplit
object[] | null

A/B split across versions: each inbound call runs the environment picked by weight (null = production). See Split calls between versions.

Required array length: 2 - 5 elements

Response

Phone number added

data
object