Easy!Appointments

Consume Easy!Appointments API

Actions38

Overview

The Easy!Appointments node for n8n allows you to interact with the Easy!Appointments API. Specifically, the Provider → Update operation updates the details of an existing provider (such as a staff member or service provider) in your Easy!Appointments system. This is useful for automating HR or scheduling workflows where provider information needs to be kept up-to-date, such as updating contact details, assigned services, working plans, or other settings.

Example scenarios:

  • Automatically update a provider's contact info when changed in another system.
  • Adjust a provider's working plan or assigned services based on business rules.
  • Sync provider data between Easy!Appointments and your HR database.

Properties

Name Type Meaning
Provider ID String The unique identifier of the provider to update.
Additional Fields Collection A set of optional fields to update for the provider. Each field below can be included as needed:
  First Name String First name of the provider.
  Last Name String Last name of the provider.
  Email String Email address of the provider.
  Phone String Phone number of the provider.
  Mobile String Mobile number of the provider.
  Address String Address of the provider.
  City String City where the provider is located.
  State String State where the provider is located.
  ZIP String ZIP code of the provider's address.
  Notes String Notes about the provider.
  Timezone String Timezone of the provider.
  Services String Comma-separated list of service IDs assigned to the provider.
  Working Plan String JSON string representing the provider's working plan.
  Calendar String Calendar settings in JSON format.
  Settings String Provider-specific settings in JSON format.

Output

  • The output will be a JSON object containing the updated provider's details as returned by the Easy!Appointments API.
  • The structure typically mirrors the provider resource, including all updated fields and possibly additional metadata from the API.

Example output:

{
  "id": "123",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "555-1234",
  "mobile": "555-5678",
  "address": "123 Main St",
  "city": "Metropolis",
  "state": "NY",
  "zip": "10001",
  "notes": "Updated via automation",
  "timezone": "America/New_York",
  "services": "1,2,3",
  "workingPlan": "{\"monday\":{\"start\":\"09:00\",\"end\":\"17:00\"}}",
  "calendar": "{}",
  "settings": "{}"
}
  • If an error occurs and "Continue On Fail" is enabled, the output will include an error field with the error message.

Dependencies

  • External Service: Requires access to an Easy!Appointments instance with API enabled.
  • API Credentials: You must configure the easyAppointmentsApi credential in n8n, which includes:
    • Base URL (without trailing slash)
    • Username
    • Password

Troubleshooting

Common Issues:

  • Missing or incorrect Provider ID: If the Provider ID does not exist, the API will return an error.
  • Invalid JSON in fields: For fields like "Working Plan", "Calendar", or "Settings", ensure valid JSON strings are provided.
  • Authentication errors: Incorrect credentials or base URL will result in authentication failures.

Error Messages:

  • "Base URL is required": Ensure the Easy!Appointments API URL is set in your credentials.
  • "error": "Some error message": If "Continue On Fail" is enabled, errors will appear in the output under the error key. Check the message for details (e.g., invalid ID, permission denied).

How to resolve:

  • Double-check the Provider ID and that the provider exists.
  • Validate any JSON input using a JSON validator.
  • Verify your API credentials and endpoint URL.

Links and References

Discussion