Skip to main content
PATCH
Update session recording capture settings

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Path Parameters

app_id
string
required

ID of the app.

Maximum string length: 64
Pattern: ^[a-zA-Z0-9._-]+$

Body

application/json
exclude_admins
boolean | null

true to leave visits by the app's owners and admins out of recording, false to record them too.

Example:

false

sampling_rate
number | null

Share of eligible visits to record, from 0 to 1 in steps of 0.05. 1 records every visit.

Required range: 0 <= x <= 1Must be a multiple of 0.05
Example:

0.5

Response

The app's updated session recording settings.

An app's session recording settings.

app_id
string
required

ID of the app.

Example:

"6820f3a4e7b91d003c45a1f2"

enabled
boolean
required

Whether recordings are on. Reads false when they were turned on but the app has since moved to another owner or workspace, or the owner's plan no longer includes recordings.

Example:

true

enabled_at
string | null

When recordings were turned on, as a UTC timestamp in ISO 8601 format, or null when they're off. A value read back carries no offset, and the response right after turning recordings on carries +00:00. The response to turning recordings off keeps the previous value.

Example:

"2026-09-01T10:15:00.123000"

enabled_by
string | null

Email of the user who turned recordings on, or null when they're off. The response to turning recordings off keeps the previous value.

Example:

"jane@acme.com"

exclude_admins
boolean
default:true

Whether visits by the app's owners and admins are left out of recording.

Example:

true

sampling_rate
number
default:1

Share of eligible visits that get recorded, from 0 to 1. 1 records every visit.

Example:

1