Apaleo icon

Apaleo

Interact with Apaleo API
Join our community

Actions45

Overview

This node interacts with the Apaleo API to perform various actions related to booking management. Specifically, for the Block Action resource and the PUT cancel block operation, it allows users to cancel an existing block by providing the block's ID and a reason for cancellation. This is useful in scenarios where a previously reserved or blocked resource (such as a room or service) needs to be released due to changes in plans or errors.

Practical examples include:

  • Canceling a room block that was mistakenly created.
  • Releasing a block on inventory when a customer cancels their request.
  • Automating cleanup of blocks that are no longer needed in a booking workflow.

Properties

Name Meaning
Block ID The unique identifier of the block to perform the cancellation action on.
Reason The explanation or justification for canceling the block.

Output

The node outputs JSON data representing the result of the cancel block operation. This typically includes confirmation details from the Apaleo API about the canceled block. The exact structure depends on the API response but generally confirms success or provides error information.

No binary data output is involved in this operation.

Dependencies

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

Troubleshooting

  • Common issues:

    • Invalid or missing Block ID: Ensure the Block ID provided exists and is correct.
    • Missing or invalid reason: The reason field is required; provide a meaningful explanation.
    • Authentication failures: Verify that the API token is valid and has not expired.
    • Network or API downtime: Check connectivity and Apaleo service status.

  • Error messages:

    • "Block not found": The specified Block ID does not exist; verify the ID.
    • "Unauthorized" or "Authentication failed": Check API credentials and permissions.
    • "Validation error": Likely caused by missing required fields like the reason; ensure all required inputs are provided.

Resolving these usually involves verifying input parameters, refreshing credentials, and ensuring network access.

Links and References

Discussion