Skip to main content
POST
Error

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.

FlowClient Credentials
Token URL
/api/v1/api-keys
Scopes1
numbers:write
Purchase / assign / release numbers.

Headers

Idempotency-Key
string

Client-supplied idempotency key on mutating POSTs. Retrying the same request with the same key returns the original result instead of creating a duplicate — send a fresh UUID per logical operation. The prefixes api_sms_send: and harness_initiate: are reserved for the platform's own records, so do not use them; an endpoint that records the key refuses one that starts with either with 400 validation_error.

Body

application/json
e164
string
required

The E.164 number to hold (e.g. +14155550100).

Response

The hold.

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