Apaleo icon

Apaleo

Interact with Apaleo API
Join our community

Actions45

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 guest details, changing reservation dates, or modifying special requests.

Practical examples:

  • Adjusting the number of guests for a reservation.
  • Changing the check-in or check-out date.
  • Updating the status or notes associated with a reservation.

Properties

Name Meaning
Reservation ID The unique identifier of the reservation to be patched.
Patch Operations reservation A JSON array describing the PATCH operations to apply. Each operation includes: op (operation type such as "replace"), path (the JSON pointer to the field), and value (the new value).

Example of patch operations JSON:

[
  {
    "op": "replace",
    "path": "/path/to/field",
    "value": "new value"
  }
]

Output

The node outputs an array of JSON objects representing the updated reservation(s) after applying the PATCH operations. The exact structure corresponds to the Apaleo API's reservation resource schema, typically including fields like reservation ID, guest information, dates, status, and other reservation details.

If the node supports binary data output, it is not indicated in the provided code or properties, so the output is purely JSON-based.

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.
  • No additional external services are required beyond the Apaleo API.

Troubleshooting

  • Invalid Reservation ID: If the reservation ID does not exist or is malformed, the API will return an error. Verify the ID before making the request.
  • Malformed PATCH JSON: The patch operations must follow the JSON Patch standard. Incorrect formatting or invalid paths will cause errors.
  • Authentication Errors: Ensure the API access token is valid and has not expired.
  • Permission Issues: The API user must have permissions to modify reservations.
  • Network Issues: Connectivity problems can cause request failures; verify network access to the Apaleo API endpoint.

Common error messages might include:

  • "Reservation not found" — Check the reservation ID.
  • "Invalid patch document" — Validate the JSON patch format.
  • "Unauthorized" or "Forbidden" — Check API credentials and permissions.

Links and References

Discussion