Create an availability calendar

Gateway module

POST/availability-calendarsavailabilityCalendars.create

A person's availability calendar. Creates an availability calendar. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability me.profile.write.
OAuth scopes: me.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: AvailabilityCalendarCreate

availabilityCalendars.create: AvailabilityCalendarCreate
Field	Type	Required	Description
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"	No	Who reads the calendar.

{
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "time_zone": "America/New_York",
  "visibility": "Private"
}

Response 201: AvailabilityCalendar

availabilityCalendars.create: 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 POST "$XOS_BASE_URL/availability-calendars" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","time_zone":"America/New_York","visibility":"Private"}'

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

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

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