appointments

CRM create scheduled appointment

Changed on

Create a scheduled appointment from CRM and optionally start immediate Stripe charge when the appointment is within 48 hours.

post/api/appointments/crm/create-scheduled

Request

  • Base URL: https://api.corabea.it (the document declares no server; this is the origin it was published from)
  • URL: https://api.corabea.it/api/appointments/crm/create-scheduled
  • Auth: HTTP bearer

Request body

patient_idstring uuid required

Patient UUID

operator_idstring uuid nullable

Operator UUID; required for admin callers, taken from the request scope otherwise

appointment_datetimestring date-time required

Appointment datetime (ISO)

operator_professionstring nullable

Operator profession hint

is_free_appointmentboolean nullable

Admin-only free appointment flag

location_typestring nullable

Location type (online/presenza/in_person)

expert_in_personboolean nullable

Whether the expert must be physically in person

room_availability_idstring uuid nullable

Room availability UUID for in-person appointments

convert_conflicting_availabilityboolean nullable

Flip a same-start opening published in the other mode instead of treating it as a conflict, and book into it atomically. Works in both directions; converting to in-person needs room_availability_id, exactly like any other in-person create.

is_familyboolean nullable

Book a family session (colloquio familiare). The appointment keeps the discipline's own type and price; the flag is what the CRM labels it by.

is_valuationboolean nullable

Book a nutritionist valuation session (appuntamento valutativo). Refused once the patient has had the limit of completed sessions.

payment_transfer_from_appointment_idstring uuid nullable

Admin/customer care only: paid appointment of the same patient whose payment moves onto the new one instead of charging the patient. That appointment is cancelled.

make_jointboolean nullable

Answer to a JOINT_APPOINTMENT_SUGGESTED response: book this session as a joint meeting with the other expert's session at the same start, converting both atomically. Ignored when no such session exists.

Response

Successful Response

successboolean required

Whether the operation completed successfully

messagestring required

Human-readable result message

codestring nullable

Stable application error/result code

appointment_idstring nullable

Created appointment UUID, if available

joint_appointment_idsstring[]

Both appointment UUIDs when the created appointment is a joint one

has_active_couponboolean

Whether the patient has an active coupon for the appointment

Changes

  • 2a4daccec07cRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 17eafc2c8d6aRevision changes
    • info

      added the optional property to the response with the status