Apaleo icon

Apaleo

Interact with Apaleo API
Join our community

Actions57

Overview

This node integrates with the Apaleo API to manage reservations, specifically allowing users to update (PATCH) a reservation by its ID. It is useful in scenarios where you need to modify specific fields of an existing reservation without replacing the entire resource. For example, updating the guest's contact information, changing reservation dates, or adjusting special requests.

Practical examples:

  • Updating the status of a reservation after confirmation.
  • Modifying the number of guests or room preferences.
  • Correcting errors in reservation details post-booking.

Properties

Name Meaning
Reservation ID The unique identifier of the reservation to be updated.
Patch Operations reservation A JSON-formatted string describing the PATCH operations to apply. Each operation includes:
- op: The operation type (e.g., "replace").
- path: The JSON pointer path to the field to update.
- value: The new value to set for the specified field.
Example: [{"op": "replace", "path": "/path/to/field", "value": "new value"}]

Output

The node outputs an array of JSON objects representing the results of the PATCH request(s) applied to the reservation(s). Each output item corresponds to one input item processed and contains the updated reservation data as returned by the Apaleo API.

If the API supports binary data in responses (not indicated here), it would be included accordingly, but this node primarily deals with JSON data representing reservation details.

Dependencies

  • Requires an active connection to the Apaleo API.
  • Needs an API authentication token (access token) configured in the node credentials.
  • The base URL for API requests is https://api.apaleo.com.
  • Proper permissions on the API key to perform PATCH operations on reservations.

Troubleshooting

  • Invalid Reservation ID: If the provided reservation ID does not exist or is malformed, the API will return an error. Verify the ID correctness.
  • Malformed PATCH JSON: The patch operations must be valid JSON and follow the JSON Patch standard. Errors in formatting or invalid paths will cause the request to fail.
  • Insufficient Permissions: Ensure the API token has rights to update reservations; otherwise, authorization errors will occur.
  • Network Issues: Connectivity problems with the Apaleo API endpoint can cause timeouts or failures.
  • Error Messages: Common error messages include "Not Found" for invalid IDs, "Bad Request" for invalid patch operations, and "Unauthorized" for credential issues. Review the error message details to adjust inputs or credentials accordingly.

Links and References

Discussion