Browser Profiles

Update browser profile

Update a browser profile's name and/or description

patch/v1/browser_profiles/{profile_id}

Path parameters

profile_idstring required

The ID of the browser profile to update. browser_profile_id starts with bp_

Example:bp_123456

The ID of the browser profile to update. browser_profile_id starts with bp_

x-api-keystring nullable

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

namestring nullable

New name for the browser profile

descriptionstring nullable

New description for the browser profile

proxy_session_idstring nullable

Opaque Skyvern-managed proxy sticky-session id.

rotate_proxy_session_idboolean

Rotate the Skyvern-managed proxy sticky-session id for this profile.

{
  "proxy_location": {
    "country": "US",
    "subdivision": "CA",
    "city": "New York"
  }
}

Successfully updated browser profile

browser_profile_idstring required

organization_idstring required

namestring required

descriptionstring nullable

source_browser_typestring nullable

proxy_session_idstring nullable

is_managedboolean

workflow_permanent_idstring nullable

browser_profile_key_digeststring nullable

created_atstring date-time required

modified_atstring date-time required

deleted_atstring date-time nullable

last_verified_login_atstring date-time nullable

linked_credential_namestring nullable

{
  "proxy_location": {
    "country": "US",
    "subdivision": "CA",
    "city": "New York"
  }
}

Changed in 6 of the 86 revisions of this API.11

Jul 24, 2026bd64e0480f0a1See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jul 22, 20265987635eae7d1See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jul 7, 2026fdc175c3bb8c3See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jun 29, 2026fc5ab0c10cbc1See the full diff
- ○
  added the new optional request property
  new-optional-request-property
Jun 26, 20269de266eb002a4See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jun 8, 20263a3616091b661See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog