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 - Create operation, it allows users to create a new customer record in the Advbox system by providing required and optional customer details.

Typical use cases include automating customer data entry workflows, integrating customer creation into broader legal or financial process automations, and syncing customer information from other systems into Advbox.

For example, you can use this node to automatically add new clients to your Advbox account when they sign up on your website or when imported from another CRM system.

Properties

Name Meaning
Name The full name of the customer to be created (required).
User ID The ID of the user responsible for the customer (selected from loaded user options) (required).
Customer Origin The origin/source of the customer (selected from loaded customer origins) (required).
Additional Fields Optional additional customer details that can be provided:
- User ID ID of the user creating the customer (number).
- Email Customer's email address (string).
- Identification Customer identification number (CPF/CNPJ) (string).
- Document Customer registration document number (string).
- Phone Customer phone number (format: 99999999999 or (99) 99999-9999) (string).
- Cellphone Customer cellphone number (format: 99999999999 or (99) 99999-9999) (string).
- Birthdate Customer birthdate (format: YYYY-MM-DD) (string).
- Occupation Customer occupation or profession (string).
- Postal Code Customer postal code (format: 99999-999) (string).
- City Customer city (string).
- State Customer state (string).
- Notes Additional notes about the customer (string).

Output

The node outputs the JSON response returned by the Advbox API after creating the customer. This typically includes the newly created customer's details such as their unique ID and all submitted fields.

The output is structured as an array of items, each containing a json property with the API response object.

No binary data output is produced 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.
  • The node uses HTTP requests to communicate with the Advbox REST API endpoints.
  • Some input properties load dynamic options via API calls (e.g., users and customer origins), so network connectivity and valid credentials are necessary.

Troubleshooting

  • Missing or invalid API token: The node will throw an error if the API token is not provided or invalid. Ensure the API key credential is correctly set up.
  • Invalid API URL: If the API base URL is missing or malformed, the request will fail. Verify the URL in the credentials.
  • Required fields missing: The "Name", "User ID", and "Customer Origin" fields are mandatory. Omitting them will cause errors.
  • API request failures: Network issues or incorrect permissions may cause request failures. Check logs for HTTP status codes and error messages.
  • Option loading failures: If user or customer origin options fail to load, verify API access and credentials.
  • Data format errors: Ensure date fields and phone numbers follow the specified formats to avoid validation errors.

Links and References


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

Discussion