Routing forms

Calculate slots based on routing form response

It will not actually save the response just return the routed event type and slots when it can be booked.

post/v2/routing-forms/{routingFormId}/calculate-slots

Request

  • The document declares no server URL.
  • Auth: none declared. Required headers: Authorization

Path parameters

routingFormIdstring required

Query parameters

startstring required
Example:2050-09-05
  Time starting from which available slots should be checked.

  Must be in UTC timezone as ISO 8601 datestring.
  
  You can pass date without hours which defaults to start of day or specify hours:
  2024-08-13 (will have hours 00:00:00 aka at very beginning of the date) or you can specify hours manually like 2024-08-13T09:00:00Z
  
endstring required
Example:2050-09-06
  Time until which available slots should be checked.
  
  Must be in UTC timezone as ISO 8601 datestring.
  
  You can pass date without hours which defaults to end of day or specify hours:
  2024-08-20 (will have hours 23:59:59 aka at the very end of the date) or you can specify hours manually like 2024-08-20T18:00:00Z
timeZonestring
Example:Europe/Rome

Time zone in which the available slots should be returned. Defaults to UTC.

durationnumber

If event type has multiple possible durations then you can specify the desired duration here. Also, if you are fetching slots for a dynamic event then you can specify the duration her which defaults to 30, meaning that returned slots will be each 30 minutes long.

format'range' | 'time'
Example:range

Format of slot times in response. Use 'range' to get start and end times.

bookingUidToReschedulestring
Example:abc123def456

The unique identifier of the booking being rescheduled. When provided will ensure that the original booking time appears within the returned available slots when rescheduling.

Headers

Authorizationstring required

value must be Bearer <token> where <token> is api key prefixed with cal_

Response

status'success' | 'error' required

Example response

{
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.