Apaleo icon

Apaleo

Interact with Apaleo API

Overview

This node integrates with the Apaleo API to manage bookings and related resources. Specifically, for the PATCH Booking operation, it allows users to update an existing booking by applying JSON Patch operations. This is useful in scenarios where partial updates to a booking are needed without sending the entire booking data again.

Practical examples include:

  • Modifying the dates or details of a reservation within a booking.
  • Updating guest information or special requests.
  • Adjusting booking status or other mutable fields dynamically.

The node supports multiple resources and operations, but focusing on the Booking resource and the PATCH Booking operation, it applies JSON Patch instructions to modify the booking identified by its ID.

Properties

Name Meaning
Booking ID The unique identifier of the booking to be updated.
Update Operations A JSON array of patch operations following the JSON Patch standard (http://jsonpatch.com/). These specify the changes to apply to the booking, such as add, remove, replace, move, copy, or test operations.

Output

The node outputs an array of JSON objects corresponding to each input item processed. For the PATCH Booking operation, the json output field contains the updated booking object reflecting the applied changes.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the Apaleo API via an API authentication token.
  • The node expects credentials providing an access token for the Apaleo API.
  • Network connectivity to https://api.apaleo.com is necessary.

Troubleshooting

  • Invalid Booking ID: If the provided Booking ID does not exist or is malformed, the API will return an error. Verify the Booking ID correctness.
  • Malformed JSON Patch: The update operations must conform strictly to the JSON Patch format. Invalid syntax or unsupported operations will cause errors.
  • Authentication Errors: Missing or expired API tokens will result in authorization failures. Ensure valid credentials are configured.
  • Partial Failures: If continueOnFail is enabled, failed updates will be reported per item; otherwise, execution stops at the first error.
  • API Rate Limits: Excessive requests may trigger rate limiting; handle retries accordingly.

Links and References

Discussion