appointments

Transition appointment status

Change an appointment's status (with an optional note) and run all status side effects.

put/api/appointments/{appointment_id}/status

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/{appointment_id}/status
  • Auth: HTTP bearer

Path parameters

appointment_idstring required

Request body

status_updatestring required

New appointment status

notesstring nullable

Optional note saved with the status change

followup_reasonstring nullable

Reason the patient did not book the next meeting, as a FollowupEmailReason value. When set on a transition to FATTO, the matching follow-up email is sent to the patient. An unknown value only skips the email: it never rejects the transition.

followup_reason_textstring nullable

Free-text reason stored with the follow-up email record when the reason is 'altro'.

Response

Successful Response

successboolean required

Operation result

titlestring

Success title

messagestring required

Human-readable message

Changes

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