Update an availability calendar

Gateway module

PATCH/availability-calendars/{id}availabilityCalendars.update

A person's availability calendar. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Requires the capability me.profile.write.
OAuth scopes: me.
Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

availabilityCalendars.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the availability calendar.

Request body: AvailabilityCalendarUpdate

availabilityCalendars.update: AvailabilityCalendarUpdate
Field	Type	Required	Description
time_zone	string	No	IANA time zone the local time was entered in.Constraints: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$
visibility	"Private" \| "Shared on Application" \| "Public"	No	Who reads the calendar.

{
  "time_zone": "America/New_York",
  "visibility": "Private"
}

Response 200: AvailabilityCalendar

availabilityCalendars.update: AvailabilityCalendar
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the availability calendar.
created_at	string (date-time)	Yes	When the row was created.
updated_at	string (date-time)	Yes	When the row was last updated.
person_id	string (uuid)	Yes	Identifier of the owner.
time_zone	string	Yes	IANA time zone the local time was entered in.Constraints: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$
visibility	"Private" \| "Shared on Application" \| "Public"	Yes	Who reads the calendar.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "time_zone": "America/New_York",
  "visibility": "Private"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/availability-calendars/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"time_zone":"America/New_York","visibility":"Private"}'

const { data, etag } = await xos.availabilityCalendars.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "time_zone": "America/New_York",
    "visibility": "Private"
  }, { ifMatch: etag });

response = xos.availability_calendars.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"time_zone": "America/New_York", "visibility": "Private"}, if_match=etag)

xos availability-calendars update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"time_zone":"America/New_York","visibility":"Private"}' --if-match auto