ADVBOX icon

ADVBOX

Consume ADVBOX API

Actions8

Overview

This node integrates with the ADVBOX API to retrieve customer data, specifically focusing on fetching customers who have birthdays in a specified month. It is useful for scenarios such as marketing campaigns, customer engagement, or sending personalized birthday greetings. For example, a business can use this node to automatically get a list of customers with birthdays in the current or any chosen month and then trigger email or SMS workflows to celebrate those occasions.

Properties

Name Meaning
Additional Fields Collection of optional parameters to refine the search:
- Month Month (1-12) to search for birthdays.
- Limit Number of items in the response, between 1 and 1000.
- Offset Number of items to skip before starting the response (pagination).

Output

The output is a JSON array where each item represents a customer with a birthday in the specified month. Each JSON object contains customer details as returned by the ADVBOX API's /customers/birthdays endpoint. The exact structure depends on the API but typically includes fields like customer ID, name, birthdate, and other relevant customer information.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the ADVBOX API.
  • The node expects the ADVBOX API URL and token to be configured in the credentials.
  • Network access to the ADVBOX API endpoint is necessary.

Troubleshooting

  • Common Issues:

    • Invalid or missing API authentication token will cause request failures.
    • Providing an invalid month number (outside 1-12) may result in no data or errors from the API.
    • Pagination parameters (limit and offset) must be within allowed ranges; otherwise, the API might reject the request.

  • Error Messages:

    • Errors related to authentication usually indicate missing or incorrect API tokens. Verify your credentials configuration.
    • Request errors may include messages from the ADVBOX API indicating invalid parameters; check that all input values conform to expected formats and ranges.
    • Network errors or timeouts suggest connectivity issues; ensure the node can reach the ADVBOX API server.

Links and References

Discussion