Skip to main content
POST
Create a snooze

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
test_ids
string[]
required

Array of Playwright test IDs (41-character hashes) to snooze.

Minimum array length: 1
snooze_until
string
required

ISO 8601 timestamp for when the snooze should expire.

description
string

Optional description explaining why the tests are being snoozed.

created_by
string

Optional user identifier for the snooze creator. Set automatically for dashboard users.

scoped_to_environment_id
number

Environment ID to scope the snooze to. If omitted, applies to all environments.

created_from_test_run_id

ID of the test run this snooze was created from, if applicable.

Response

The created snooze.

data
object
required

Response payload.