SimplyBook.me icon

SimplyBook.me

Consume SimplyBook.me API

Overview

The node integrates with the SimplyBook.me API to manage bookings. Specifically, the "Edit Booking" operation allows users to update details of an existing booking such as service, provider, location, category, date/time, count, and client information. This is useful in scenarios where appointments or reservations need to be modified after creation, for example, changing the time of a client’s appointment or updating the assigned service provider.

Practical examples:

  • Rescheduling a client’s appointment to a new date and time.
  • Changing the service or provider associated with a booking.
  • Updating the number of attendees or participants for a booking.

Properties

Name Meaning
Service Name or ID Select or specify the service related to the booking.
Provider Name or ID Select or specify the provider responsible for the booking.
Location Name or ID Select or specify the location where the booking will take place.
Category Name or ID Select or specify the category under which the booking falls.
Date and Time The new date and time for the booking (required).
Count Number of slots or participants for the booking (required).
Booking ID The unique identifier of the booking to edit (required).
Client Name or ID Select or specify the client associated with the booking.

Output

The node outputs JSON data representing the updated booking details after the edit operation completes successfully. This typically includes confirmation of the changes made, such as updated service, provider, date/time, and other booking attributes.

If the node supports binary data output (not explicitly shown here), it would generally relate to attachments or documents linked to the booking, but this is not indicated in the provided code or properties.

Dependencies

  • Requires an active SimplyBook.me account and API access.
  • Needs an API key credential configured in n8n to authenticate requests.
  • The base URL for the SimplyBook.me API must be set in the credentials.
  • Uses internal methods to load options dynamically for services, providers, locations, categories, and clients.

Troubleshooting

  • Missing Required Fields: Ensure that required fields like Booking ID, Date and Time, and Count are provided; otherwise, the API call will fail.
  • Invalid IDs: Using invalid or non-existent service, provider, location, category, or client IDs may cause errors or no updates.
  • Authentication Errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Date/Time Format Issues: The Date and Time field must be in a valid ISO format; incorrect formatting can lead to request rejection.
  • Network or API Downtime: Temporary connectivity issues or SimplyBook.me API downtime can cause failures; retry later if needed.

Links and References

Discussion