Saltar al contenido principal
POST
Claim a number

Autorizaciones

Authorization
string
header
requerido

An API key from Settings > API keys (lsk_...), which acts on its own business, or a platform key from the PLATFORM_API_KEYS setting (lsp_...), which onboards and manages businesses. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:read, knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage, team:manage, businesses:create, users:create. Only platform keys can hold businesses:create and users:create.

Encabezados

LobbyStack-Business
string<uuid>

The business a platform key acts on. Required with a platform key. A per-business key may leave it out; if it sends one, it must be the key's own business.

Idempotency-Key
string
requerido

Required. A unique value, up to 255 characters, that makes retries of this request safe.

Maximum string length: 255

Cuerpo

application/json
offer_token
string
requerido

An offer_token from POST /phone-numbers/search.

Required string length: 1 - 4000

Respuesta

Accepted

data
object
requerido

A request to buy a phone number for the business.