CAcarecycle
Calendars

Create calendar

Create a booking calendar that sets when appointments can be booked and who they go to. Fields keep the older appointmentConfig names.

post/v2/calendars

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/calendars
  • Auth
    API key in header x-api-key

Request body

namestring

Calendar name

descriptionstring nullable

Markdown-supported description shown on the public booking page

concurrentLimitinteger
appointmentLengthinteger
appointmentSpacinginteger
maxOptionsinteger
minDatestring date nullable

Earliest appointment date. Canonical format: YYYY-MM-DD

maxDatestring date nullable

Latest appointment date. Canonical format: YYYY-MM-DD

minHoursinteger nullable
preferredMode'timezone' | 'zipcode'
appointmentMode'phone_call' | 'in_person' | 'video_call' | 'agent_phone_call'
showCallerIdOnBookingPageboolean
assignmentMode'customer_agent' | 'routing_config' | 'external_transfer'
routingConfigIdstring uuid nullable

Legacy routing mirror for routing_config assignments. Prefer transferConfigId.

transferConfigIdstring uuid nullable

Routing group for routing_config and external_transfer assignments

Response

POST /v2/calendars Positive response

Changes

No recorded changes to this operation across all 2 revisions of this API.