Apaleo icon

Apaleo

Interact with Apaleo API

Overview

This node integrates with the Apaleo API to manage group bookings within a property management or booking system. Specifically, the DELETE operation for the Group resource allows users to delete an existing group booking by specifying its unique Group ID. This is useful in scenarios where a group reservation needs to be canceled or removed from the system, such as when a client cancels their entire group stay.

Practical examples include:

  • Removing a group booking after a cancellation request.
  • Cleaning up test or dummy group bookings during development or maintenance.
  • Automating group booking lifecycle management by deleting outdated or invalid groups.

Properties

Name Meaning
Group ID The unique identifier of the group booking to delete. This is required to specify which group booking should be removed.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will confirm whether the deletion was successful or provide details if it failed. The exact structure depends on the Apaleo API response but generally includes status information and possibly metadata about the deleted group.

No binary data output is expected from this operation.

Dependencies

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

Troubleshooting

  • Common issues:

    • Invalid or missing Group ID: Ensure the Group ID provided exists and is correctly formatted.
    • Authentication errors: Verify that the API token is valid and has not expired.
    • Permission denied: Confirm that the API credentials have rights to delete group bookings.
    • Network or connectivity problems: Check internet access and API endpoint availability.
  • Error messages:

    • "Group not found": The specified Group ID does not exist; verify the ID.
    • "Unauthorized" or "Forbidden": Authentication failed or insufficient permissions; check API credentials.
    • "Bad Request": Input parameters may be malformed; ensure Group ID is correct.

Resolving these typically involves verifying input parameters, refreshing credentials, and checking API permissions.

Links and References

Discussion