Skip to content

Delete an availability calendar

Gateway module

DELETE/availability-calendars/{id}availabilityCalendars.delete

A person's availability calendar. Soft-deletes the availability calendar: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability me.profile.write.
  • OAuth scopes: me.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

availabilityCalendars.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the availability calendar.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/availability-calendars/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.availabilityCalendars.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.availability_calendars.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos availability-calendars delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f