Skip to main content
POST
Save a profile setup session

Authorizations

X-API-Key
string
header
required

API key for authentication. Get your key from the API Keys page.

Path Parameters

profileId
string
required

Browser Context Profile ID

Minimum string length: 1
Example:

"prof_abc123def4567890"

Body

application/json
session_id
string
required
Minimum string length: 1
Example:

"br-a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

Save a profile setup session succeeded.

domains_updated
string[]
required
Example:
domains_failed
string[]
required
Example:
Required range: x >= 0
Example:

12

domains_skipped
object
required
pages_captured
integer
Required range: x >= 0
Example:

1

target_reads_skipped
integer
Required range: x >= 0
Example:

0

cleanup_failed
boolean
Example:

false

cleanup_kind
string
Example:

"post_save"