Amelia icon

Amelia

Interact with Amelia API

Actions119

Packages → Add Appointment

AI-generated

Summary

Adds an appointment to an Amelia package by sending the configured appointment details in the request body. Provide the booking start time and bookings, and set optional payment, provider, service, location, notification, and other appointment fields as needed.

Inputs

  • Booking Start (required) — Appointment start time, sent as bookingStart (default 2023-05-23 19:30).
  • Bookings (required) — JSON array of booking records, parsed and sent as bookings. The default shows fields such as customer ID, duration, persons, status, extras, payments, and package customer ID.
  • Create Payment Links — Boolean sent as createPaymentLinks; defaults to false.
  • Id — Numeric appointment ID sent as id; defaults to 0.
  • Internal Notes — Text sent as internalNotes; defaults to empty.
  • Lesson Space — Text sent as lessonSpace; defaults to null.
  • Location Id — Numeric location ID sent as locationId; defaults to 2.
  • Notify Participants — Numeric notification setting sent as notifyParticipants; defaults to 1.
  • Payment — JSON payment object, parsed and sent as payment; default is {"amount":0,"gateway":"onSite"}.
  • Provider Id — Numeric provider ID sent as providerId; defaults to 1.
  • Service Id — Numeric service ID sent as serviceId; defaults to 4.
  • Utc — Boolean sent as utc; defaults to false.

Output shape

A single item containing the API response.

The source pack shows the node's OpenAPI-driven request setup but not the endpoint response schema, so response fields are unspecified. Request Options also exposes generic batching, SSL certificate validation, proxy, and timeout settings.

Examples

Example 1: Create a package appointment with one booking

Set Booking Start and provide a Bookings JSON array with the customer, duration, package customer, and other booking details. Adjust payment, provider, service, location, or notification fields if needed.

Links

Discussion