PUT
/
v1
/
profiles
/
{name}
curl --request PUT \
  --url https://api.anchorbrowser.io/v1/profiles/{name} \
  --header 'Content-Type: application/json' \
  --header 'anchor-api-key: <api-key>' \
  --data '{
  "description": "Updated profile description.",
  "source": "session",
  "session_id": "550e8400-e29b-41d4-a716-446655440000",
  "store_cache": true
}'
{
  "data": {
    "status": "success"
  }
}

Authorizations

​
anchor-api-key
string
header
required

API key passed in the header

Path Parameters

​
name
string
required

The name of the profile to update.

Example:

"my-profile"

Body

application/json
​
description
string

The new description for the profile.

Example:

"Updated profile description."

​
source
enum<string>

The source of the profile data. Currently, only session is supported.

Available options:
session
Example:

"session"

​
session_id
string

The browser session ID is required if the source is set to session. The browser session must belong to the user and be active.

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
store_cache
boolean

Indicates whether the browser session cache should be saved when the browser session ends. Defaults to false.

Example:

true

Response

200
application/json
Profile updated successfully.
​
data
object