Actions17
Appointment → Create
AI-generatedSummary
Create a new appointment record in the Stenci API
Inputs
- scheduleId (required) — ID of the schedule
- professionalId (required) — ID of the professional
- date (required) — Date of the appointment (YYYY-MM-DD)
- hour (required) — Time of the appointment (HH:MM)
- serviceId (required) — ID of the service
- patientName (required) — Name of the patient
- patientBirthDate (required) — Birth date of the patient (YYYY-MM-DD)
- patientGender (required) — Gender of the patient
- identityType (required) — Type of patient identity document
- identityValue (required) — Patient identity document number
- additionalFields (required) — Additional fields for the appointment (e.g., cellphone, email, insurance plan, notes, origin)
Output shape
a single created appointment record
The operation returns the created appointment object; errors are thrown unless continueOnFail is enabled.
Examples
Example 1: Schedule a new appointment with all required fields
Set Schedule ID, Professional ID, Date, Hour, Service ID, Patient Name, Patient Birth Date, Patient Gender, Identity Type, Identity Value, and optionally fill Additional Fields such as Patient Cellphone, Email, Insurance Plan ID, Notes, and Origin.
Example 2: Create an appointment with minimal required data
Provide only the mandatory fields (Schedule ID, Professional ID, Date, Hour, Service ID, Patient Name, Patient Birth Date, Patient Gender, Identity Type, Identity Value); leave Additional Fields empty.
Example 3: Create an appointment within a workflow
Connect the node to preceding nodes, map the required input parameters, and route the created appointment output to subsequent steps.