Apaleo icon

Apaleo

Interact with Apaleo API

Overview

This node interacts with the Apaleo API to perform various operations related to booking management. Specifically, for the Block Action resource and the PUT amend block operation, it updates an existing block with new data. This is useful in scenarios where you need to modify details of a previously created block, such as changing dates, quantities, or other block attributes.

Practical examples include:

  • Amending a room block reservation to update the number of rooms held.
  • Changing the dates or conditions of a block without cancelling and recreating it.
  • Adjusting block metadata or custom fields after initial creation.

Properties

Name Meaning
Block ID The unique identifier of the block to be amended.
Block Data JSON object containing the data fields and values to update the block with.

Output

The node outputs an array of JSON objects representing the response from the Apaleo API after attempting to amend the block. Each item corresponds to one input item processed. The json field contains the updated block information returned by the API.

If the operation fails for any item and "Continue On Fail" is enabled, the output will include an error message for that item instead of block data.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Apaleo API using an API authentication token (provided via credentials).
  • The node expects the base URL https://api.apaleo.com and uses JSON content type headers.
  • Proper permissions on the API key are necessary to amend blocks.

Troubleshooting

  • Common issues:
    • Invalid or missing Block ID will cause the API call to fail.
    • Malformed JSON in the Block Data property can lead to request errors.
    • Insufficient API permissions or expired tokens will result in authorization errors.
  • Error messages:
    • "Block not found" indicates the specified Block ID does not exist.
    • "Unauthorized" or "Forbidden" suggests credential or permission problems.
    • "Invalid JSON" or similar parsing errors mean the Block Data input is incorrectly formatted.
  • Resolutions:
    • Verify the Block ID is correct and exists in Apaleo.
    • Ensure the Block Data JSON is valid and matches expected schema.
    • Check API credentials and renew or update them if expired or lacking required scopes.

Links and References

Discussion