Skip to main content
POST

Request Body

string
Custom name for the phone (optional). If not provided, a default name will be generated.
string
default:"US"
ISO 3166-1 alpha-2 country code for the phone’s proxy location (e.g. US, GB, DE). Determines where the phone’s IP address appears to be located, which affects what content and audiences are available on TikTok and Instagram. Defaults to US if not provided.Supported values: US, GB, DE, ES, CA, FR, IT, PT, AE, AR, AT, AU, BD, BE, BG, BR, CH, CL, CO, CY, CZ, DK, DZ, EG, FI, GE, GR, HK, HN, HR, HU, ID, IE, IL, IN, JP, KE, KR, KZ, LT, MA, MT, MX, MY, NG, NL, NO, NZ, PE, PH, PK, PL, RO, SA, SE, SG, SK, TH, TR, TW, UA, VN, ZA

Response

boolean
Whether the phone was created successfully (true or false).
string
Unique identifier for the phone.
number
The assigned phone slot number.
string
ID of the proxy assigned to this phone.
string
Current status: pending_setup, ready, or failed.
string
Success message confirming phone creation.
string
ISO 8601 timestamp of when the phone was created.

Provisioning Process

  1. Request Submitted (instant): Phone provisioning request is queued
  2. Phone Slot Assignment: System assigns next available phone slot
  3. Infrastructure Allocation (30-90 seconds): Phone resources are allocated

Error Responses

Phone Limit Reached
User Not Found
API Error
Unauthenticated