Update Browser Profile

Rename a profile or change its userId. Send a field as null to clear it; omit to leave it.

PATCH /browser-profiles/{profile_id}

Update Browser Profile

JavaScript

const options = {
  method: 'PATCH',
  headers: {'X-Browser-Use-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', userId: '<string>'})
};

fetch('https://api-staging-ufcbwvyv9yifyyvc3.browser-use.com/api/v1/browser-profiles/{profile_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request PATCH \
  --url https://api-staging-ufcbwvyv9yifyyvc3.browser-use.com/api/v1/browser-profiles/{profile_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Browser-Use-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "userId": "<string>"
}
'

import requests

url = "https://api-staging-ufcbwvyv9yifyyvc3.browser-use.com/api/v1/browser-profiles/{profile_id}"

payload = {
    "name": "<string>",
    "userId": "<string>"
}
headers = {
    "X-Browser-Use-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "userId": "<string>",
  "lastUsedAt": "2023-11-07T05:31:56Z"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-Browser-Use-API-Key · string · header · required

Path Parameters

profile_id · string<uuid> · required

Body

application/json

name · string | null

New name. Null clears it; omit to leave unchanged.

userId · string | null

New user id. Null clears it; omit to leave unchanged.

Response

200

application/json

Successful Response

id · string<uuid> · required

createdAt · string<date-time> · required

name · string | null

userId · string | null

Your internal user id for this profile.

lastUsedAt · string<date-time> | null

When a run last used this profile, if ever.