Skip to main content
POST
imessage.sender.purchase

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
kind
enum<string>
required

Sender address type to rent.

Available options:
phone,
email
region
enum<string>
required

Phone region; also used to match the configured plan.

Available options:
US,
GB,
AU
plan
string
required

Explicit neutral plan choice from your configured rental choices; no default.

Required string length: 1 - 64
areaCode
string

Preferred area code, where supported.

Required string length: 1 - 3
Pattern: ^\d{3}$
name
string

Email local part when buying an email sender.

Required string length: 1 - 64
Pattern: ^[a-zA-Z0-9._-]+$
domain
string

Email sender domain.

addOns
enum<string>[]

Optional recurring features; no automatic additions.

Maximum array length: 3

An explicitly priced sender option.

Available options:
sms-and-call,
whatsapp,
init-conversations
zipCode
string

US postal code, when supported.

Required string length: 1 - 10
port
object

Explicit phone transfer details, when supported.

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.