Snoozes the run for the caller until a moment still to come, or moves the moment of a snooze already set.
POST
/v1/m/sessions/runs/{ref}/snooze
const url = 'https://example.com/v1/m/sessions/runs/example/snooze';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"until":"2026-04-15T12:00:00Z"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/v1/m/sessions/runs/example/snooze \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "until": "2026-04-15T12:00:00Z" }'Snoozes the run for the caller until a moment still to come, or moves the moment of a snooze already set.
Authorizations
Section titled “ Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “ Path Parameters ” ref
required
string
Path parameter ref.
Header Parameters
Section titled “ Header Parameters ” X-Olivares-Tenant
string format: uuid
Target tenant id; required when the principal can act in more than one tenant.
Request Body required
Section titled “ Request Body required ” Media type application/json
object
until
required
When the session comes back to the caller’s list, an RFC 3339 time in the future. A second snooze moves it.
string format: date-time
Example generated
{ "until": "2026-04-15T12:00:00Z"}Responses
Section titled “ Responses ”The caller’s snooze and done marks on the run
Media type application/json
object
done
required
Whether THIS caller has marked the session done; every direction is idempotent.
boolean
run_ref
required
The operated session’s stable reference.
string
snoozed_until
When THIS caller’s snooze ends; present only while it is still to end. Run list and get reads carry the same per-caller fields.
string format: date-time
Example generated
{ "done": true, "run_ref": "example", "snoozed_until": "2026-04-15T12:00:00Z"}Bad request
Media type application/json
object
Example generated
{}Unauthenticated
Media type application/json
object
Example generated
{}Forbidden
Media type application/json
object
Example generated
{}Not found
Media type application/json
object
Example generated
{}Conflict / setup required
Media type application/json
object
Example generated
{}Rate limited
Media type application/json
object
Example generated
{}