Apaleo icon

Apaleo

Interact with Apaleo API

Actions66

Folio → PATCH folio

AI-generated

Overview

This node operation updates a folio in the Apaleo system by applying a list of patch operations defined in JSON format. It is useful for scenarios where you need to modify specific fields or attributes of a folio without replacing the entire resource. For example, updating billing details or adjusting folio entries in a hotel management context.

Use Case Examples

  1. Updating the billing address of a folio by specifying the folio ID and the patch operations in JSON format.
  2. Modifying folio entries such as charges or payments by sending patch operations to the Apaleo API.

Properties

Name Meaning
Folio ID The unique identifier of the folio to be updated.
Update Operations A JSON array defining the list of patch operations to apply to the folio, following the JSON Patch format.

Output

JSON

  • id - The ID of the updated folio.
  • status - The status of the folio after the update.
  • updatedFields - Details of the fields that were updated as a result of the patch operations.

Dependencies

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

Troubleshooting

  • Ensure the Folio ID is valid and exists in the Apaleo system to avoid 'not found' errors.
  • Verify the JSON patch format in the 'Update Operations' property to prevent malformed request errors.
  • Check API authentication token validity and permissions to ensure the update operation is authorized.

Discussion