Advbox icon

Advbox

Consume Advbox API - Clean Version 1.0.0

Actions5

Overview

This node integrates with the Advbox API to retrieve customer birthday information. Specifically, the "Get Birthdays" operation fetches a list of customers who have upcoming or recent birthdays. This can be useful for marketing campaigns, customer engagement, or sending personalized greetings.

Practical examples:

  • Automatically generate a list of customers with birthdays in the current month to send promotional offers.
  • Use the birthday data to trigger email workflows wishing customers a happy birthday.
  • Analyze customer birthdate trends for business insights.

Properties

Name Meaning
Additional Fields Optional parameters to customize the request:
- Limit Maximum number of birthday records to return (default 50).
- Offset Number of records to skip before starting to return results (default 0).

Output

The node outputs an array of JSON objects representing customers' birthday data. Each object corresponds to a customer and includes relevant fields as returned by the Advbox API's /customers/birthdays endpoint.

The output does not include binary data; it is purely JSON-formatted customer information.

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.
  • No additional external dependencies beyond the Advbox API.

Troubleshooting

  • Missing or invalid API token: The node throws an error if the API token is missing or empty. Ensure that the API key credential is correctly set up.
  • Invalid API URL: If the API base URL is not provided or malformed, the node will error out. Verify the API URL in the credentials.
  • API request errors: Network issues or incorrect parameters may cause HTTP errors. The node logs the status code and response body on failure to help diagnose issues.
  • Limit and offset values: Providing negative or non-numeric values for limit or offset may cause unexpected behavior. Use valid positive integers.

Links and References

Discussion