Easy!Appointments

Consume Easy!Appointments API

Actions38

Overview

The Unavailability → Update operation in the Easy!Appointments n8n node allows you to update an existing unavailability record in your Easy!Appointments system. This is useful for managing and modifying periods when a provider is not available, such as vacations, breaks, or other absences.

Common scenarios:

  • Adjusting the start or end time of a provider's unavailability.
  • Changing the location or notes associated with an unavailability period.
  • Reassigning the unavailability to a different provider.

Practical example:
If a staff member extends their vacation by a day, you can use this operation to update the "End" date of their unavailability record.

Properties

Name Type Meaning
Unavailability ID String The unique identifier of the unavailability record you want to update.
Additional Fields Object (Collection) Optional fields to update details of the unavailability. Includes:
• Start (String): Start date and time (format: YYYY-MM-DD HH:MM:SS)
• End (String): End date and time (format: YYYY-MM-DD HH:MM:SS)
• Location (String): Location of the unavailability
• Notes (String): Notes for the unavailability
• Provider ID (String): ID of the provider

Output

  • The output will be a JSON object representing the updated unavailability record as returned by the Easy!Appointments API.
  • The structure typically includes all properties of the unavailability, such as its ID, start/end times, location, notes, and provider information.
  • 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 09:00:00",
  "end": "2024-07-01 17:00:00",
  "location": "Main Office",
  "notes": "Annual leave",
  "providerId": "456"
}

Dependencies

  • External Service: Requires access to an Easy!Appointments instance with API enabled.
  • Authentication: Needs valid credentials (username, password, and base URL) configured in n8n under "easyAppointmentsApi".
  • n8n Configuration: No special environment variables required beyond standard credential setup.

Troubleshooting

Common issues:

  • Invalid Unavailability ID: If the provided ID does not exist, the API will return an error.
  • Missing Required Fields: The "Unavailability ID" is mandatory; omitting it will cause the node to fail.
  • Incorrect Date Format: Dates must be in "YYYY-MM-DD HH:MM:SS" format; otherwise, the API may reject the request.
  • Authentication Errors: Incorrect credentials or missing base URL will result in authentication failures.

Error messages and resolutions:

  • "Base URL is required": Ensure the Easy!Appointments API base URL is set in the credentials.
  • "401 Unauthorized": Check that your username and password are correct.
  • "Unavailability not found": Verify the Unavailability ID exists in your Easy!Appointments system.
  • "Validation failed": Double-check the format and presence of required fields, especially dates.

Links and References

Discussion