Skip to main content
PATCH
Update Browser Profile

Authorizations

X-API-KEY
string
header
required

Client-side API key (ck_...) with the agent-checkouts.* scopes.

Authorization
string
header
required

JWT identifying the end user, issued by an external auth provider your project trusts.

Path Parameters

id
string<uuid>
required

The browser profile id (returned by create).

Body

application/json

The label is the only editable field.

label
string
required

The new human-readable label for the profile.

Required string length: 1 - 120

Response

Returns the updated browser profile.

The browser profile, returned by create, get, list items, and update. Metadata only — no cookies, tokens, or local storage.

id
string<uuid>
required

The browser profile id. Pass it as browserProfileId when creating a checkout.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required

When the label was last changed. Checkout runs do not update it.

label
string

Optional human-readable label for the profile.

Required string length: 1 - 120