Skip to main content
POST
This endpoint is for the VIP plan only. Other plans get a 403. See Plan access.
The number is billed every month until you release it. Search first, then buy one of the numbers the search gave you.
string
required
The number in E.164 format, for example +14155551234. US and Canada local numbers only.
Must be true. You agree to pay for this number every month until you release it. We record your API key, your IP address and your user agent with the purchase.
string
Workspace UUID. Required for an account API key. A workspace API key uses its own workspace.

Retries

You can send the same request again. If the workspace already owns the number, you get 200 with that number and nothing is charged. While a purchase of the number is still running, you get 409. If an earlier purchase of the number may have taken money and never finished, you also get 409, at any age. The message has a reference. Contact support with it before you buy the number again. When a purchase fails after the number was held for you, the number stays held for about 30 minutes. A retry before then is refused. Try again after that, or pick another number.

Errors