Skip to main content
POST
Allocate a virtual number to an end-user

Authorizations

Authorization
string
header
required

Your API key from the Wave dashboard. Sandbox keys start sk_sandbox_; production keys start sk_live_. Send as Authorization: Bearer <key>. Some endpoints require a production key and specific scopes.

Body

application/json
external_user_id
string
required
Required string length: 1 - 128
display_name
string
Maximum string length: 120
type
enum<string>
Available options:
mobile,
landline,
tollfree,
unified,
shortcode
prefix
string
Maximum string length: 8
instructions
object

Response

Idempotent retry — existing allocation returned

data
object