Calendar

Book Meeting

Book a meeting with a staff group at a specific time slot.

This endpoint is authenticated using a service token (Bearer token in Authorization header).

This endpoint:

  1. Resolves the staff group from case_id (or defaults to first Office group)
  2. Checks if the call is a test call - if so, returns mock data without booking
  3. Checks which members of the staff group are available at the requested time
  4. Randomly selects one available member
  5. Books the meeting on that member's calendar
  • call_id: The ID of the call (required to determine if this is a test call)
  • case_id: Optional ID of case to get assigned staff group (defaults to first Office group)
  • first_name: Client's first name
  • last_name: Client's last name
  • phone_number: Client's phone number
  • email: (deprecated) Optional client's email address
  • time_slot: The desired meeting time (datetime with timezone)

Returns: Information about the booked meeting including the assigned staff member.

post/calendars/book-meeting

Request body

call_idstring uuid required
case_idstring uuid nullable
first_namestring required
last_namestring required
phone_numberstring required
emailstring nullable
time_slotstring date-time required
attendee_timezonestring required

Response

Successful Response

messagestring required
staff_group_idstring uuid required
assigned_user_idstring uuid required
assigned_user_namestring required
time_slotstring required
meeting_duration_minutesinteger required

Changes

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