Apaleo icon

Apaleo

Interact with Apaleo API

Actions66

Block Action → PUT cancel block

AI-generated

Overview

This node performs a 'cancel block' action on a specified block within the Apaleo API. It is used to cancel an existing block by providing the block's ID and a reason for cancellation. This operation is useful in scenarios where a previously reserved or blocked resource needs to be released or invalidated, such as canceling a room block in a hotel booking system.

Use Case Examples

  1. Cancel a room block by specifying the block ID and providing a reason for cancellation to update the booking system accordingly.
  2. Automate the cancellation of blocks in bulk by feeding multiple block IDs and reasons into the node.

Properties

Name Meaning
Block ID The ID of the block to perform the action on, required to identify which block to cancel.
Reason The reason for canceling the block, required to provide context for the cancellation.

Output

JSON

  • blockId - The ID of the block that was canceled.
  • reason - The reason provided for canceling the block.
  • status - The status or result of the cancel block operation, indicating success or failure.

Dependencies

  • Requires an API authentication token (access token) for the Apaleo API to authorize the cancel block request.

Troubleshooting

  • Common issues include invalid or missing block ID, which will cause the API to reject the request.
  • Missing or invalid API credentials will result in authentication errors.
  • If the reason for cancellation is not provided, the operation may fail validation.
  • Network or API endpoint issues can cause request failures; ensure the base URL and network connectivity are correct.

Discussion