Claim a number
Buys the offered number for the business and connects it to the receptionist. It costs money, so Idempotency-Key is required. Returns the claim at once; poll GET /phone-numbers/claims/ until its status is claimed or failed. A business that already has a number, including one still being released, or another claim in progress gets a 409. Claims are limited to 3 an hour, 2 a day and 5 in 30 days, past which they are a 429. Platform keys count each business’s claims; other keys count the claims of the account they act as. A trial offer starts the business’s 14-day free trial. As in the dashboard, each business, account and verified phone gets one trial. The dashboard also allows one trial per network in 30 days, and the API doesn’t: an integration claims for all of its customers from the same addresses.
Authorizations
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.
Headers
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.
Required. A unique value, up to 255 characters, that makes retries of this request safe.
255Body
An offer_token from POST /phone-numbers/search.
1 - 4000Response
Accepted
A request to buy a phone number for the business.