latestOpenAPI 3.1.1Proprietary – Contact us for usage terms2026-08-20173183551.4 KB

9da73dd2f99e

users

Set or clear a user's snooze status

Activates or deactivates snooze mode for a user. When snooze is active, the user is marked as unavailable and incoming calls are not routed to them (calls go to voicemail or are forwarded according to the user's call routing rules). The name field selects a predefined snooze label (e.g., "meeting", "lunch", "break") — use GET /snoozes to retrieve available labels. The optional duration field sets an auto-expiry in seconds; if null or omitted, snooze remains active until explicitly cleared. To clear snooze, send name as an empty string.

Permission: Users Write required.

Monitoring: Not needed. This route works regardless of the Monitoring flag.

put/users/{userId}/snooze

Path parameters

userIdinteger required

The identifier of the user

Request body

namestring
durationinteger nullable

Duration of snooze in seconds

Example request

{
  "name": "meeting",
  "duration": 3600
}

Response

Successful operation