ADVBOX icon

ADVBOX

Consume Advbox API

Actions14

Overview

This node integrates with the Advbox API to manage various resources such as customers, lawsuits, tasks, movements, settings, and transactions. Specifically, for the Customer resource with the Get birthdays operation, it retrieves a list of customers who have birthdays in the current month.

This operation is useful for scenarios like sending birthday greetings, marketing campaigns targeting customers on their birthdays, or generating reports about upcoming customer birthdays.

Practical example:
A business wants to automatically send personalized birthday emails to customers whose birthdays fall in the current month. Using this node's "Get birthdays" operation, they can fetch those customers and trigger email workflows accordingly.


Properties

Name Meaning
Additional Fields Optional parameters to customize the request:
- Limit: Number of items to return (between 1 and 1000). Default is 10.
- Offset: Number of items to skip before starting the response (for pagination). Default is 0.

Output

The output is a JSON array containing customer objects with birthday information for the current month. Each item represents a customer record returned by the Advbox API.

The exact structure depends on the API response but typically includes fields such as customer ID, name, birthdate, and other customer details.

No binary data is output by this operation.


Dependencies

  • Requires an API key credential for authenticating with the Advbox API.
  • The node expects the Advbox API base URL and token to be configured in the credentials.
  • No additional external dependencies are required beyond the Advbox API access.

Troubleshooting

  • Common issues:

    • Missing or invalid API token: The node will throw an error if the API token is not provided or invalid.
    • Invalid API URL configuration: Ensure the API URL is correctly set in the credentials.
    • Pagination parameters out of range: Limit must be between 1 and 1000; setting values outside this range may cause errors or unexpected results.
  • Error messages:

    • "API Token não fornecido ou inválido. Verifique suas credenciais."
      Means the API token is missing or invalid. Check your API key credential setup.
    • "URL da API não fornecida ou inválida. Verifique suas credenciais."
      Means the API URL is missing or invalid. Verify the API endpoint URL in your credentials.
    • Network or request errors from the Advbox API will be propagated. Check network connectivity and API status.

Links and References


If you need details on other operations or resources, feel free to ask!

Discussion