Update User Availability Schedule
Renames a schedule, changes its timezone or rules, or makes it the default.
Behavior:
- Omitted fields are left unchanged. When rules is sent, it replaces the schedule’s entire rule set.
- To change part of the rules, such as one weekday or one date, read the schedule with GET /user_availability_schedules/{uuid}, edit it, and send all the rules back.
- date rules dated before yesterday, in the schedule’s timezone, return 400. Yesterday and later dates are allowed.
- default: true makes this schedule the default and the previous default stops being one, in a single step. The user never has zero defaults.
- default: false is not a supported target state and returns 400.
- Changes apply to every Event Type that uses the schedule. Which Event Types use it does not change.
Required scopes
availability:write
Authentication
AuthorizationBearer
OAuth 2.0
OR
AuthorizationBearer
Personal Access Token
Path parameters
uuid
The UUID of the availability schedule.
Request
This endpoint expects an object.
name
New name for the availability schedule.
timezone
IANA time zone used to interpret the schedule's availability rules. Changing it is expected to keep each rule's local times, so their absolute times shift.
rules
Complete replacement set of availability rules for the schedule. Same structure and validation as rules in Create User Availability Schedule. Must include exactly one wday rule for each day of the week when provided. date rules are optional overrides on top of the weekly rules.
default
Sets the availability schedule as the user's default schedule when true. false is not a supported target state and returns 400.
Response
OK
resource
The availability schedule set by the user.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error