Create Browser Profile

Create a new browser profile with custom settings for ad blocking, proxy usage, and viewport dimensions. Pay as you go users can only have one profile. Subscription users can create multiple profiles.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
profile_namestringRequired>=1 character<=100 characters
descriptionstringOptional>=0 characters<=1000 charactersDefaults to
persistbooleanOptionalDefaults to false
ad_blockerbooleanOptionalDefaults to true
proxybooleanOptionalDefaults to false
proxy_country_codeenumOptional
store_cachebooleanOptionalDefaults to false
browser_viewport_widthintegerOptional>=100<=3840Defaults to 1280
browser_viewport_heightintegerOptional>=100<=2160Defaults to 960
is_mobilebooleanOptionalDefaults to false

Response

Successful Response
profile_idstringformat: "uuid"
profile_namestring
descriptionstring
persistboolean
ad_blockerboolean
proxyboolean
proxy_country_codeenum
browser_viewport_widthinteger
browser_viewport_heightinteger
store_cacheboolean
is_mobileboolean

Errors