Billing Booth One icon

Billing Booth One

Interact with Billing Booth One API

Actions476

Overview

This node interacts with the Billing Booth One API to update a Customer Access Banner. It allows users to modify banner details such as description, URL, and additional optional fields like title, display settings for light and dark themes, and click counts. This node is useful for managing customer-facing banners dynamically within an automation workflow, for example, updating promotional banners or informational messages on a customer portal.

Use Case Examples

  1. Updating a banner's description and URL to reflect a new promotion.
  2. Changing the accessibility title and display settings for light and dark themes to improve user experience.
  3. Tracking and updating the number of clicks on a banner for analytics purposes.

Properties

Name Meaning
Organisation Id Unique identifier for the organisation to which the banner belongs.
Id Unique identifier of the customer access banner to update.
Description Text description of the banner, which is updated in the API request body.
Url Destination URL that the banner links to when clicked, sent in the API request body.
Additional Body Fields Optional additional fields to include in the update request body, such as id, title (accessibility text), display_light (boolean to show banner under light theme), display_dark (boolean to show banner under dark theme), and clicks (total number of clicks).

Output

JSON

  • data - Response data from the Billing Booth One API after updating the customer access banner.

Dependencies

  • Requires an API key credential for Billing Booth One API authentication.

Troubleshooting

  • Common issues include missing or invalid organisationId or banner id, which will cause the API request to fail.
  • Errors related to missing required fields like description or url will result in request errors from the API.
  • If the API base URL or access token is incorrect or expired, authentication errors will occur.
  • Ensure that additional body fields are correctly formatted and valid to avoid request validation errors.

Discussion