PUT
/
users
/
{user}
/
quiet-hours
curl --request PUT \
  --url https://cloud.local.wirtual.dev/api/v2/users/{user}/quiet-hours \
  --header 'Content-Type: application/json' \
  --header 'Wirtual-Session-Token: <api-key>' \
  --data '{
  "schedule": "<string>"
}'
[
  {
    "next": "2023-11-07T05:31:56Z",
    "raw_schedule": "<string>",
    "time": "<string>",
    "timezone": "<string>",
    "user_can_set": true,
    "user_set": true
  }
]

Authorizations

​
Wirtual-Session-Token
string
header
required

Path Parameters

​
user
string
required

User ID

Body

application/json
Update schedule request
​
schedule
string
required

Schedule is a cron expression that defines when the user's quiet hours window is. Schedule must not be empty. For new users, the schedule is set to 2am in their browser or computer's timezone. The schedule denotes the beginning of a 4 hour window where the workspace is allowed to automatically stop or restart due to maintenance or template schedule.

The schedule must be daily with a single time, and should have a timezone specified via a CRON_TZ prefix (otherwise UTC will be used).

If the schedule is empty, the user will be updated to use the default schedule.

Response

200 - application/json
OK
​
next
string

Next is the next time that the quiet hours window will start.

​
raw_schedule
string
​
time
string

Time is the time of day that the quiet hours window starts in the given Timezone each day.

​
timezone
string

raw format from the cron expression, UTC if unspecified

​
user_can_set
boolean

UserCanSet is true if the user is allowed to set their own quiet hours schedule. If false, the user cannot set a custom schedule and the default schedule will always be used.

​
user_set
boolean

UserSet is true if the user has set their own quiet hours schedule. If false, the user is using the default schedule.