Skip to main content
PATCH
/
api
/
snoozes
/
{id}
Update Snooze
curl --request PATCH \
  --url https://dash.empirical.run/api/snoozes/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "snooze_until": "<string>",
  "description": "<string>",
  "expire_now": true,
  "scoped_to_environment_id": 123,
  "test_ids": [
    "<string>"
  ]
}
'
{
  "data": {
    "snooze": {
      "id": 12,
      "test_ids": [
        "a30a6eba6312f6b87ea5-55e241fbe3f4b8ae61ee"
      ],
      "snooze_until": "2026-05-01T00:00:00.000Z",
      "description": "Extended — fix delayed to next sprint",
      "created_from_test_run_id": 456,
      "created_by": null,
      "created_at": "2026-03-15T10:30:00.000Z",
      "updated_at": "2026-03-20T14:00:00.000Z",
      "scoped_to_environment_id": null
    }
  }
}
Updates an existing snooze. Use this to extend, expire, or modify a snooze.

Examples

{
  "data": {
    "snooze": {
      "id": 12,
      "test_ids": [
        "a30a6eba6312f6b87ea5-55e241fbe3f4b8ae61ee"
      ],
      "snooze_until": "2026-05-01T00:00:00.000Z",
      "description": "Extended — fix delayed to next sprint",
      "created_from_test_run_id": 456,
      "created_by": null,
      "created_at": "2026-03-15T10:30:00.000Z",
      "updated_at": "2026-03-20T14:00:00.000Z",
      "scoped_to_environment_id": null
    }
  }
}

Extend snooze duration

curl -X PATCH \
  https://dash.empirical.run/api/snoozes/12 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $EMPIRICALRUN_KEY" \
  -d '{
    "snooze_until": "2026-05-01T00:00:00.000Z"
  }'

Expire a snooze

curl -X PATCH \
  https://dash.empirical.run/api/snoozes/12 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $EMPIRICALRUN_KEY" \
  -d '{
    "expire_now": true
  }'

Update description

curl -X PATCH \
  https://dash.empirical.run/api/snoozes/12 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $EMPIRICALRUN_KEY" \
  -d '{
    "description": "Extended — fix delayed to next sprint"
  }'

Authorizations

Authorization
string
header
required

API key from the Empirical dashboard.

Path Parameters

id
integer
required

Snooze ID.

Required range: -9007199254740991 <= x <= 9007199254740991

Body

application/json

Fields to update.

snooze_until
string
description
string
expire_now
boolean
scoped_to_environment_id
number | null
test_ids
string[]

Response

Updated snooze.

data
object
required