Apaleo icon

Apaleo

Interact with Apaleo API

Actions66

Reservation → PATCH reservation by ID

AI-generated

Overview

This node operation allows users to update a reservation by its ID using the PATCH HTTP method. It is useful for modifying specific fields of an existing reservation without replacing the entire resource. Common scenarios include updating reservation details such as dates, guest information, or status.

Use Case Examples

  1. Updating the check-in date of a reservation by providing the reservation ID and the patch operation to replace the check-in date field.
  2. Changing the status of a reservation to 'confirmed' by specifying the reservation ID and the appropriate patch operation.

Properties

Name Meaning
Reservation ID The unique identifier of the reservation to be updated.
Patch Operations reservation A JSON-formatted string specifying the PATCH operations to apply to the reservation, such as replace, add, or remove operations on specific fields.

Output

JSON

  • id - The unique identifier of the updated reservation.
  • status - The current status of the reservation after the update.
  • guestDetails - Information about the guest associated with the reservation.
  • dates - The reservation dates, including check-in and check-out.
  • otherFields - Other reservation fields that may be updated and returned by the API.

Dependencies

  • Requires an API authentication token (access token) for the Apaleo API.

Troubleshooting

  • Ensure the Reservation ID is valid and exists in the system; otherwise, the API will return an error.
  • The PATCH operations must be correctly formatted as a JSON array of operations with 'op', 'path', and 'value' fields; invalid JSON or incorrect paths will cause the request to fail.
  • If the API returns authentication errors, verify that the access token is valid and has not expired.

Discussion