Skip to main content
POST
/
numbers
/
purchase
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "data": {
    "id": "<string>",
    "organizationId": "<string>",
    "e164": "<string>",
    "provider": "<string>",
    "defaultAgentId": "<string>",
    "monthlyCost": 123,
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Headers

​
Idempotency-Key
string

Client-supplied idempotency key on mutating POSTs (API-First).

Body

application/json
​
e164
string
required
​
reservationId
string

Optional id from POST /numbers/reserve. When present the number is already held for this org, so the order cannot be sniped.

Response

Purchased number.

​
success
boolean
required
​
data
object
required
​
message
string
​
errors
object[]