Easy!Appointments

Consume Easy!Appointments API

Actions38

Overview

The Easy!Appointments node for n8n allows you to interact with the Easy!Appointments API. Specifically, when using the Appointment resource and the Update operation, this node updates an existing appointment in your Easy!Appointments system. This is useful for workflows where you need to modify appointment details—such as rescheduling, changing participants, updating notes, or adjusting status—based on triggers or other automation steps.

Practical examples:

  • Automatically update an appointment's time if a customer requests a change via another channel.
  • Change the status of an appointment after payment confirmation.
  • Add notes or change the assigned provider based on workflow logic.

Properties

Name Type Meaning
Appointment ID String The unique identifier of the appointment to update. Required.
Additional Fields Collection Optional fields to update. Each field below can be included as needed:
└ Start String Start date and time of the appointment (format: YYYY-MM-DD HH:MM:SS).
└ End String End date and time of the appointment (format: YYYY-MM-DD HH:MM:SS).
└ Location String Location of the appointment.
└ Color String Color code for the appointment.
└ Status String Status of the appointment.
└ Notes String Notes for the appointment.
└ Customer ID String ID of the customer associated with the appointment.
└ Provider ID String ID of the provider assigned to the appointment.
└ Service ID String ID of the service linked to the appointment.

Output

  • The output will be a JSON object representing the updated appointment as returned by the Easy!Appointments API.
  • The structure typically includes all appointment fields, such as IDs, start/end times, status, location, notes, and any other properties supported by the API.
  • If an error occurs and "Continue On Fail" is enabled, the output will contain an error field with the error message.

Example output:

{
  "id": "123",
  "start": "2024-07-01 10:00:00",
  "end": "2024-07-01 11:00:00",
  "location": "Main Office",
  "color": "#FF0000",
  "status": "confirmed",
  "notes": "Customer requested earlier slot.",
  "customerId": "456",
  "providerId": "789",
  "serviceId": "101"
}

Note: Actual fields depend on the Easy!Appointments API response.

Dependencies

  • External Service: Requires access to an Easy!Appointments instance with API enabled.
  • API Credentials: You must configure credentials (easyAppointmentsApi) in n8n, including:
    • Base URL (without trailing slash)
    • Username
    • Password
  • n8n Configuration: No special environment variables are required beyond standard credential setup.

Troubleshooting

Common issues:

  • Missing or incorrect Appointment ID: If the provided Appointment ID does not exist, the API will return an error.
  • Invalid date/time format: Ensure dates are in YYYY-MM-DD HH:MM:SS format.
  • Authentication errors: Incorrect username/password or base URL will result in authentication failures.
  • Empty additional fields: If no fields are provided in "Additional Fields," the request may succeed but not change any data.

Error messages:

  • "Base URL is required": Make sure the Easy!Appointments API URL is set in your credentials.
  • "error": "Not Found": The specified Appointment ID does not exist.
  • "error": "Unauthorized": Check your API credentials.
  • Other API errors will be passed through in the error field if "Continue On Fail" is enabled.

Links and References

Discussion