Skip to content

Modify browser profile

Request

Update an existing browser profile. Only the fields present in the request are changed.

  • Preconditions: the profile must exist in the team. End-to-end encrypted profiles cannot be updated. The operating system and browser type cannot be changed. A running profile can be updated.
  • Effect: writes the profile row, its expanded settings and cookies, and merges the advanced fingerprint settings (existing values are kept unless overwritten).
  • Completion: synchronous.
  • Retry: safe to repeat with the same body. Note there is no optimistic locking: concurrent updates to one profile are last-write-wins, and the fingerprint merge reads before it writes, so concurrent callers can lose changes.

Documented business errors: 19001, 19039, 19104, 19105, 19106, 19107, 19108, 19142, 19159, 19160, 19175, 19193. See Error Codes for what each code means. Any operation can additionally return the common codes.

Bodyapplication/json
browserTypeIdinteger

Browser type ID; 1=Chrome, 2=Firefox

operatorSystemIdinteger

OS type ID; 1:Windows 2:macOS 3:Android 4:IOS 5:Linux

isEncryptinteger

Whether to encrypt the profile; 0=No, 1=Yes

startupParamsArray of strings

Additional browser startup parameters

accountInfoobject(AccountInfo)

Account information

advancedSettingobject(AdvancedSetting)

Advanced browser fingerprint settings

afterStartupConfigobject(AfterStartupConfig)

Configurations after startup

browserCoreinteger

Kernel version; default:0 (auto-match). Fetch available versions via /api/env/advanced/ua/versions.

cookiesstring

Cookie string to preload (optional)

envNamestring

Environment name

envRemarkstring

Environment remark; max length:1500 chars

groupIdstring

Environment group ID; default:ungrouped (0)

groupNamestring, <= 50 characters

Group name (max 50 characters). If provided, the system first checks groupId: if a valid group is found, it is used; otherwise, it searches by groupName. If a group with that name exists, it is referenced; if not, a new group is created. Each team is limited to 1,000 groups.

proxyIdstring

Proxy ID; default:0

tagIdsArray of strings

Tag IDs; default:none

uaVersioninteger

UA preset version; default:0 (all)

disableAudiointeger

Disable audio:0 = off, 1 = on

disableImginteger

Disable image loading:0 = off, 1 = on

disableVideointeger

Disable video loading:0 = off, 1 = on

imgLimitSizeinteger

Max image size (KB)

envIdstringrequired

Environment ID

hostnameSourceinteger

Device name source:

  • 0 — custom
  • 1 — real
Enum:01
Example:0
hostnamestring

Device name. Used when hostnameSource is 0.

Example:"DESKTOP-OPENAPI"
macAddressSourceinteger

MAC address source:

  • 0 — custom
  • 1 — real
Enum:01
Example:0
macAddressstring

MAC address. Used when macAddressSource is 0.

Example:"00:16:3E:12:34:56"
curl -i -X POST \
  http://127.0.0.1:40000/api/env/update \
  -H 'Content-Type: application/json' \
  -d '{
    "browserTypeId": 1,
    "operatorSystemId": 1,
    "isEncrypt": 1,
    "envId": "1661515884160372",
    "hostnameSource": 0,
    "hostname": "DESKTOP-OPENAPI",
    "macAddressSource": 0,
    "macAddress": "00:16:3E:12:34:56"
  }'

Responses

Success. data is always null for this operation; the outcome is carried by code.

Headers
any
Bodyapplication/json
codeintegerrequired
msgstring or nullrequired
datanullrequired
requestIdstringrequired
Response
{ "code": 0, "msg": null, "data": null, "requestId": "0d8b6f1c-9f4e-4d02-9d1a-7c3f5a1b2c3d" }