---
title: "Update a running session"
method: PUT
path: "/api/session/{id}/update"
---

# Update a running session

`PUT /api/session/{id}/update`

Update supported settings on an active browser session. Supported update types are profile, proxy, screen, and solveCaptchas.

## Path parameters

- `id` string, required

## Request body

- union
  - UpdateSessionProfileRequest
    - `type` 'profile', required
    - `params` UpdateSessionProfileParams, required
      - `persistChanges` boolean — Whether profile changes should be persisted after the session ends.
      - `persistNetworkCache` boolean — Whether network cache should be persisted into the profile.
  - UpdateSessionProxyRequest
    - `type` 'proxy', required
    - `params` UpdateSessionProxyParams, required
      - `enabled` boolean, required — Whether proxying should be active for the running session.
      - `staticIpId` string, uuid — Static IP allocation to use when enabling a static IP proxy.
      - `location` UpdateSessionProxyLocationParams
        - `country` 'AD' | 'AE' | 'AF' | 'AL' | 'AM' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AZ' | 'BA' | 'BD' | 'BE' | 'BG' | 'BH' | 'BJ' | 'BO' | 'BR' | 'BS' | 'BT' | 'BY' | 'BZ' | 'CA' | 'CF' | 'CH' | 'CI' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'EC' | 'EE' | 'EG' | 'ES' | 'ET' | 'EU' | 'FI' | 'FJ' | 'FR' | 'GB' | 'GE' | 'GH' | 'GM' | 'GR' | 'HK' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JM' | 'JO' | 'JP' | 'KE' | 'KH' | 'KR' | 'KW' | 'KZ' | 'LB' | 'LI' | 'LR' | 'LT' | 'LU' | 'LV' | 'MA' | 'MC' | 'MD' | 'ME' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MR' | 'MT' | 'MU' | 'MV' | 'MX' | 'MY' | 'MZ' | 'NG' | 'NL' | 'NO' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PH' | 'PK' | 'PL' | 'PR' | 'PT' | 'PY' | 'QA' | 'RANDOM_COUNTRY' | 'RO' | 'RS' | 'RU' | 'SA' | 'SC' | 'SD' | 'SE' | 'SG' | 'SI' | 'SK' | 'SN' | 'SS' | 'TD' | 'TG' | 'TH' | 'TM' | 'TN' | 'TR' | 'TT' | 'TW' | 'UA' | 'UG' | 'US' | 'UY' | 'UZ' | 'VE' | 'VG' | 'VN' | 'YE' | 'ZA' | 'ZM' | 'ZW' | 'ad' | 'ae' | 'af' | 'al' | 'am' | 'ao' | 'ar' | 'at' | 'au' | 'aw' | 'az' | 'ba' | 'bd' | 'be' | 'bg' | 'bh' | 'bj' | 'bo' | 'br' | 'bs' | 'bt' | 'by' | 'bz' | 'ca' | 'cf' | 'ch' | 'ci' | 'cl' | 'cm' | 'cn' | 'co' | 'cr' | 'cu' | 'cy' | 'cz' | 'de' | 'dj' | 'dk' | 'dm' | 'ec' | 'ee' | 'eg' | 'es' | 'et' | 'eu' | 'fi' | 'fj' | 'fr' | 'gb' | 'ge' | 'gh' | 'gm' | 'gr' | 'hk' | 'hn' | 'hr' | 'ht' | 'hu' | 'id' | 'ie' | 'il' | 'in' | 'iq' | 'ir' | 'is' | 'it' | 'jm' | 'jo' | 'jp' | 'ke' | 'kh' | 'kr' | 'kw' | 'kz' | 'lb' | 'li' | 'lr' | 'lt' | 'lu' | 'lv' | 'ma' | 'mc' | 'md' | 'me' | 'mg' | 'mk' | 'ml' | 'mm' | 'mn' | 'mr' | 'mt' | 'mu' | 'mv' | 'mx' | 'my' | 'mz' | 'ng' | 'nl' | 'no' | 'nz' | 'om' | 'pa' | 'pe' | 'ph' | 'pk' | 'pl' | 'pr' | 'pt' | 'py' | 'qa' | 'ro' | 'rs' | 'ru' | 'sa' | 'sc' | 'sd' | 'se' | 'sg' | 'si' | 'sk' | 'sn' | 'ss' | 'td' | 'tg' | 'th' | 'tm' | 'tn' | 'tr' | 'tt' | 'tw' | 'ua' | 'ug' | 'us' | 'uy' | 'uz' | 've' | 'vg' | 'vn' | 'ye' | 'za' | 'zm' | 'zw'
        - `state` 'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'al' | 'ak' | 'az' | 'ar' | 'ca' | 'co' | 'ct' | 'de' | 'fl' | 'ga' | 'hi' | 'id' | 'il' | 'in' | 'ia' | 'ks' | 'ky' | 'la' | 'me' | 'md' | 'ma' | 'mi' | 'mn' | 'ms' | 'mo' | 'mt' | 'ne' | 'nv' | 'nh' | 'nj' | 'nm' | 'ny' | 'nc' | 'nd' | 'oh' | 'ok' | 'or' | 'pa' | 'ri' | 'sc' | 'sd' | 'tn' | 'tx' | 'ut' | 'vt' | 'va' | 'wa' | 'wv' | 'wi' | 'wy', nullable — Optional state code for proxies to US states. Is mutually exclusive with proxyCity. Takes in two letter state code.
        - `city` string — City for managed proxy geolocation.
  - UpdateSessionScreenRequest
    - `type` 'screen', required
    - `params` UpdateSessionScreenParams, required
      - `width` integer, required
      - `height` integer, required
  - UpdateSessionSolveCaptchasRequest
    - `type` 'solveCaptchas', required
    - `params` UpdateSessionSolveCaptchasParams, required
      - `enabled` boolean, required — Whether automatic CAPTCHA solving should be enabled for this running session.
      - `solverType` 'visual' — Optional CAPTCHA solver mode. Set to visual to use the visual reCAPTCHA solver.

## Response `200`

Session updated successfully

- UpdateSessionResponse
  - `success` boolean, required
  - `solveCaptchas` boolean — Returned for solveCaptchas updates.
  - `sessionId` string — Returned for solveCaptchas updates.
  - `telemetryReady` boolean — Returned for solveCaptchas updates.

## Other responses

- `400` — Invalid update request
- `404` — Session not found
- `409` — CAPTCHA evaluation is already running
- `500` — Server error

---

[API](https://skmtc.net/hyperbrowser/apis/hyperbrowser-api.md) · [All operations](https://skmtc.net/hyperbrowser/apis/hyperbrowser-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hyperbrowser/hyperbrowser-api/versions/69aa004ce41b/schema)