Easy!Appointments

Consume Easy!Appointments API

Actions38

Overview

The Secretary - Update operation in the Easy!Appointments n8n node allows you to update the details of an existing secretary in your Easy!Appointments system. This is useful for keeping secretary records up-to-date, such as when their contact information, assigned providers, or other profile details change.

Common scenarios:

  • Updating a secretary's email, phone number, or address.
  • Assigning or removing providers that a secretary can manage.
  • Modifying notes, settings, or calendar view preferences for a secretary.

Practical example:
If a secretary changes their phone number or needs access to manage additional providers, you can use this operation to update their record automatically as part of your workflow.


Properties

Name Type Meaning
Secretary ID String The unique identifier of the secretary to update.
Additional Fields Collection A set of optional fields to update on the secretary's profile. Includes:
  First Name String First name of the secretary.
  Last Name String Last name of the secretary.
  Email String Email address of the secretary.
  Phone String Phone number of the secretary.
  Mobile String Mobile number of the secretary.
  Address String Address of the secretary.
  City String City where the secretary is located.
  State String State where the secretary is located.
  ZIP String ZIP code of the secretary's location.
  Notes String Notes about the secretary.
  Timezone String Timezone of the secretary.
  Settings String Secretary settings in JSON format.
  Calendar View String Calendar view settings in JSON format.
  Providers String Comma-separated list of provider IDs this secretary can manage.

Output

  • The output will be a JSON object representing the updated secretary record as returned by the Easy!Appointments API.
  • The structure typically includes all secretary fields (such as id, firstName, lastName, email, phone, etc.) with their updated values.
  • 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",
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@example.com",
  "phone": "555-1234",
  "providers": "1,2,3",
  ...
}

or, on error:

{
  "error": "Secretary not found"
}

Dependencies

  • External Service: Requires access to an Easy!Appointments instance with API enabled.
  • API Credentials: You must configure the easyAppointmentsApi credential in n8n, including:
    • Base URL of your Easy!Appointments installation
    • Username and password with sufficient permissions to update secretaries

Troubleshooting

Common issues:

  • Invalid Secretary ID: If the provided Secretary ID does not exist, you'll receive an error like "Secretary not found".
  • Missing Required Fields: If required fields are missing, the API may return validation errors.
  • Authentication Errors: Incorrect credentials or insufficient permissions will result in authentication failures.
  • Malformed JSON: If you provide invalid JSON in fields like "Settings" or "Calendar View", the API may reject the request.

How to resolve:

  • Double-check the Secretary ID exists in your Easy!Appointments system.
  • Ensure all required fields are filled and formatted correctly.
  • Verify your API credentials in n8n.
  • Validate any JSON strings before submitting.

Links and References

Discussion