Skip to main content
PUT
/
browser
/
{id}
/
custom
Update profile with partial parameters
curl --request PUT \
  --url https://api.gologin.com/browser/{id}/custom \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Test Profile",
  "notes": "Temporary profile for testing",
  "autoLang": true,
  "lockEnabled": false,
  "folderName": "<string>",
  "os": "win",
  "osSpec": "win11",
  "devicePixelRatio": 1,
  "dns": "8.8.8.8",
  "timezone": {
    "enabled": true,
    "fillBasedOnIp": true,
    "timezone": "America/New_York"
  },
  "audioContext": {
    "mode": "noise",
    "noise": 0.1
  },
  "canvas": {
    "mode": "off",
    "noise": 0.1
  },
  "webGL": {
    "mode": "noise",
    "getClientRectsNoise": 0.5,
    "noise": 0.5
  },
  "clientRects": {
    "mode": "noise",
    "noise": 0.5
  },
  "webGLMetadata": {
    "vendor": "Google Inc. (Intel)",
    "renderer": "ANGLE (Intel, Intel(R) HD Graphics 630 Direct3D11 vs_5_0 ps_5_0, D3D11)",
    "mode": "mask"
  },
  "chromeExtensions": [],
  "userChromeExtensions": [],
  "folders": [],
  "createProxy": false,
  "startUrl": "",
  "storage": {
    "local": true,
    "extensions": true,
    "bookmarks": true,
    "history": true,
    "passwords": true,
    "session": true,
    "indexedDb": false,
    "enableExternalExtensions": false
  }
}
'
import requests

url = "https://api.gologin.com/browser/{id}/custom"

payload = {
    "name": "My Test Profile",
    "notes": "Temporary profile for testing",
    "autoLang": True,
    "lockEnabled": False,
    "folderName": "<string>",
    "os": "win",
    "osSpec": "win11",
    "devicePixelRatio": 1,
    "dns": "8.8.8.8",
    "timezone": {
        "enabled": True,
        "fillBasedOnIp": True,
        "timezone": "America/New_York"
    },
    "audioContext": {
        "mode": "noise",
        "noise": 0.1
    },
    "canvas": {
        "mode": "off",
        "noise": 0.1
    },
    "webGL": {
        "mode": "noise",
        "getClientRectsNoise": 0.5,
        "noise": 0.5
    },
    "clientRects": {
        "mode": "noise",
        "noise": 0.5
    },
    "webGLMetadata": {
        "vendor": "Google Inc. (Intel)",
        "renderer": "ANGLE (Intel, Intel(R) HD Graphics 630 Direct3D11 vs_5_0 ps_5_0, D3D11)",
        "mode": "mask"
    },
    "chromeExtensions": [],
    "userChromeExtensions": [],
    "folders": [],
    "createProxy": False,
    "startUrl": "",
    "storage": {
        "local": True,
        "extensions": True,
        "bookmarks": True,
        "history": True,
        "passwords": True,
        "session": True,
        "indexedDb": False,
        "enableExternalExtensions": False
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'My Test Profile',
    notes: 'Temporary profile for testing',
    autoLang: true,
    lockEnabled: false,
    folderName: '<string>',
    os: 'win',
    osSpec: 'win11',
    devicePixelRatio: 1,
    dns: '8.8.8.8',
    timezone: {enabled: true, fillBasedOnIp: true, timezone: 'America/New_York'},
    audioContext: {mode: 'noise', noise: 0.1},
    canvas: {mode: 'off', noise: 0.1},
    webGL: {mode: 'noise', getClientRectsNoise: 0.5, noise: 0.5},
    clientRects: {mode: 'noise', noise: 0.5},
    webGLMetadata: {
      vendor: 'Google Inc. (Intel)',
      renderer: 'ANGLE (Intel, Intel(R) HD Graphics 630 Direct3D11 vs_5_0 ps_5_0, D3D11)',
      mode: 'mask'
    },
    chromeExtensions: [],
    userChromeExtensions: [],
    folders: [],
    createProxy: false,
    startUrl: '',
    storage: {
      local: true,
      extensions: true,
      bookmarks: true,
      history: true,
      passwords: true,
      session: true,
      indexedDb: false,
      enableExternalExtensions: false
    }
  })
};

fetch('https://api.gologin.com/browser/{id}/custom', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gologin.com/browser/{id}/custom",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'My Test Profile',
    'notes' => 'Temporary profile for testing',
    'autoLang' => true,
    'lockEnabled' => false,
    'folderName' => '<string>',
    'os' => 'win',
    'osSpec' => 'win11',
    'devicePixelRatio' => 1,
    'dns' => '8.8.8.8',
    'timezone' => [
        'enabled' => true,
        'fillBasedOnIp' => true,
        'timezone' => 'America/New_York'
    ],
    'audioContext' => [
        'mode' => 'noise',
        'noise' => 0.1
    ],
    'canvas' => [
        'mode' => 'off',
        'noise' => 0.1
    ],
    'webGL' => [
        'mode' => 'noise',
        'getClientRectsNoise' => 0.5,
        'noise' => 0.5
    ],
    'clientRects' => [
        'mode' => 'noise',
        'noise' => 0.5
    ],
    'webGLMetadata' => [
        'vendor' => 'Google Inc. (Intel)',
        'renderer' => 'ANGLE (Intel, Intel(R) HD Graphics 630 Direct3D11 vs_5_0 ps_5_0, D3D11)',
        'mode' => 'mask'
    ],
    'chromeExtensions' => [
        
    ],
    'userChromeExtensions' => [
        
    ],
    'folders' => [
        
    ],
    'createProxy' => false,
    'startUrl' => '',
    'storage' => [
        'local' => true,
        'extensions' => true,
        'bookmarks' => true,
        'history' => true,
        'passwords' => true,
        'session' => true,
        'indexedDb' => false,
        'enableExternalExtensions' => false
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gologin.com/browser/{id}/custom"

	payload := strings.NewReader("{\n  \"name\": \"My Test Profile\",\n  \"notes\": \"Temporary profile for testing\",\n  \"autoLang\": true,\n  \"lockEnabled\": false,\n  \"folderName\": \"<string>\",\n  \"os\": \"win\",\n  \"osSpec\": \"win11\",\n  \"devicePixelRatio\": 1,\n  \"dns\": \"8.8.8.8\",\n  \"timezone\": {\n    \"enabled\": true,\n    \"fillBasedOnIp\": true,\n    \"timezone\": \"America/New_York\"\n  },\n  \"audioContext\": {\n    \"mode\": \"noise\",\n    \"noise\": 0.1\n  },\n  \"canvas\": {\n    \"mode\": \"off\",\n    \"noise\": 0.1\n  },\n  \"webGL\": {\n    \"mode\": \"noise\",\n    \"getClientRectsNoise\": 0.5,\n    \"noise\": 0.5\n  },\n  \"clientRects\": {\n    \"mode\": \"noise\",\n    \"noise\": 0.5\n  },\n  \"webGLMetadata\": {\n    \"vendor\": \"Google Inc. (Intel)\",\n    \"renderer\": \"ANGLE (Intel, Intel(R) HD Graphics 630 Direct3D11 vs_5_0 ps_5_0, D3D11)\",\n    \"mode\": \"mask\"\n  },\n  \"chromeExtensions\": [],\n  \"userChromeExtensions\": [],\n  \"folders\": [],\n  \"createProxy\": false,\n  \"startUrl\": \"\",\n  \"storage\": {\n    \"local\": true,\n    \"extensions\": true,\n    \"bookmarks\": true,\n    \"history\": true,\n    \"passwords\": true,\n    \"session\": true,\n    \"indexedDb\": false,\n    \"enableExternalExtensions\": false\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.gologin.com/browser/{id}/custom")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My Test Profile\",\n  \"notes\": \"Temporary profile for testing\",\n  \"autoLang\": true,\n  \"lockEnabled\": false,\n  \"folderName\": \"<string>\",\n  \"os\": \"win\",\n  \"osSpec\": \"win11\",\n  \"devicePixelRatio\": 1,\n  \"dns\": \"8.8.8.8\",\n  \"timezone\": {\n    \"enabled\": true,\n    \"fillBasedOnIp\": true,\n    \"timezone\": \"America/New_York\"\n  },\n  \"audioContext\": {\n    \"mode\": \"noise\",\n    \"noise\": 0.1\n  },\n  \"canvas\": {\n    \"mode\": \"off\",\n    \"noise\": 0.1\n  },\n  \"webGL\": {\n    \"mode\": \"noise\",\n    \"getClientRectsNoise\": 0.5,\n    \"noise\": 0.5\n  },\n  \"clientRects\": {\n    \"mode\": \"noise\",\n    \"noise\": 0.5\n  },\n  \"webGLMetadata\": {\n    \"vendor\": \"Google Inc. (Intel)\",\n    \"renderer\": \"ANGLE (Intel, Intel(R) HD Graphics 630 Direct3D11 vs_5_0 ps_5_0, D3D11)\",\n    \"mode\": \"mask\"\n  },\n  \"chromeExtensions\": [],\n  \"userChromeExtensions\": [],\n  \"folders\": [],\n  \"createProxy\": false,\n  \"startUrl\": \"\",\n  \"storage\": {\n    \"local\": true,\n    \"extensions\": true,\n    \"bookmarks\": true,\n    \"history\": true,\n    \"passwords\": true,\n    \"session\": true,\n    \"indexedDb\": false,\n    \"enableExternalExtensions\": false\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.gologin.com/browser/{id}/custom")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My Test Profile\",\n  \"notes\": \"Temporary profile for testing\",\n  \"autoLang\": true,\n  \"lockEnabled\": false,\n  \"folderName\": \"<string>\",\n  \"os\": \"win\",\n  \"osSpec\": \"win11\",\n  \"devicePixelRatio\": 1,\n  \"dns\": \"8.8.8.8\",\n  \"timezone\": {\n    \"enabled\": true,\n    \"fillBasedOnIp\": true,\n    \"timezone\": \"America/New_York\"\n  },\n  \"audioContext\": {\n    \"mode\": \"noise\",\n    \"noise\": 0.1\n  },\n  \"canvas\": {\n    \"mode\": \"off\",\n    \"noise\": 0.1\n  },\n  \"webGL\": {\n    \"mode\": \"noise\",\n    \"getClientRectsNoise\": 0.5,\n    \"noise\": 0.5\n  },\n  \"clientRects\": {\n    \"mode\": \"noise\",\n    \"noise\": 0.5\n  },\n  \"webGLMetadata\": {\n    \"vendor\": \"Google Inc. (Intel)\",\n    \"renderer\": \"ANGLE (Intel, Intel(R) HD Graphics 630 Direct3D11 vs_5_0 ps_5_0, D3D11)\",\n    \"mode\": \"mask\"\n  },\n  \"chromeExtensions\": [],\n  \"userChromeExtensions\": [],\n  \"folders\": [],\n  \"createProxy\": false,\n  \"startUrl\": \"\",\n  \"storage\": {\n    \"local\": true,\n    \"extensions\": true,\n    \"bookmarks\": true,\n    \"history\": true,\n    \"passwords\": true,\n    \"session\": true,\n    \"indexedDb\": false,\n    \"enableExternalExtensions\": false\n  }\n}"

response = http.request(request)
puts response.read_body

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Id of the profile.

Query Parameters

​
workspaceId
string

Body

application/json
​
name
string

Profile name.

Example:

"My Test Profile"

​
notes
string

Here you can put some information about the profile that wil help you to navigate.

Example:

"Temporary profile for testing"

​
autoLang
boolean

If true, the browser will automatically change the language to the language of your location or proxy location if proxy is enabled.

Example:

true

​
lockEnabled
boolean
default:false

If enabled - other users will not be able to run this profile when its already running.

Example:

false

​
folderName
string
​
bookmarks
object

Bookmarks of the browser that will be created.

​
os
enum<string>

OS type. It should be the same with the OS you want to run the browser on.

Available options:
lin,
mac,
win,
android,
android-cloud,
ios
Example:

"win"

​
osSpec
enum<string>

Here you can specify OS specification. For example chip version for macos or version of windows.

Available options:
M1,
M2,
M3,
M4,
M5,
A18,
win11,
Example:

"win11"

​
devicePixelRatio
number

Parameter of mobile devices, tablets and notebooks. If you not sure what to put - leave it empty.

Example:

1

​
navigator
object
​
proxy
object
​
dns
string
default:""

Allows you to specify custom DNS (Domain Name System) settings for the browser profile.

Example:

"8.8.8.8"

​
timezone
object

The timezone configuration is a setting that controls how the browser handles time and date information.

​
geolocation
object

Geolocation in the browser is a feature that allows websites to access the user's geographical location.

​
audioContext
object

AudioContext is a configuration component that controls how Chromium handles the Web Audio API.

​
canvas
object

Canvas is a browser feature that utilizes the HTML5 Canvas API for rendering 2D and 3D graphics in web browsers.

​
fonts
object

Fonts are a configuration component that controls how Chromium handles the Fonts API.

​
mediaDevices
object

A feature that provides access to connected media input and output devices like cameras, microphones, and speakers.

​
webRTC
object

WebRTC in browser configuration refers to settings that control how the browser handles real-time communication protocols.

​
webGL
object

WebGL (Web Graphics Library) is a JavaScript API in Chromium-based browsers that allows websites to render interactive 2D and 3D graphics without requiring plugins. It provides direct access to the computer's GPU(Graphics Processing Unit) for accelerated rendering.

​
clientRects
object

Controls whether the client rectangle values are randomized.

​
webGLMetadata
object

Controls WebGL metadata such as vendor and renderer information.

​
chromeExtensions
string[]

List of Chrome extensions to be installed in the browser profile.

​
userChromeExtensions
string[]

List of custom Chrome extensions to be installed in the browser profile.

​
folders
string[]

List of folder identifiers associated with this browser profile for organization.

​
createProxy
boolean

If you want to create a proxy for the profile.

Example:

false

​
startUrl
string
default:""
​
storage
object

Response

200 - undefined