Beex icon

Beex

Beex Contact Center API Interaction and Consumption

Client → Create One

AI-generated

Overview

This node interacts with the Beex Contact Center API to create a new client contact within a specified portfolio (campaign). It allows users to input essential client details such as first name, paternal surname, and portfolio ID, along with a wide range of optional custom fields and filters to enrich the client data. This node is useful for automating the addition of new client contacts into the Beex platform, facilitating campaign management and client tracking.

Use Case Examples

  1. Creating a new client contact in a marketing campaign by specifying their name, portfolio ID, and additional demographic or custom information.
  2. Automating client data entry from external sources into the Beex platform to maintain up-to-date contact lists for outreach campaigns.

Properties

Name Meaning
Portfolio ID The ID of the portfolio (campaign) to which the new client contact will belong.
First Name The first name of the client contact.
Paternal Surname The paternal surname (father's last name) of the client contact.
Custom Fields Additional optional custom fields to provide more detailed client information, such as maternal surname, document number, birthdate, sex, job position, salary, and various text and numeric fields.
Custom Filters Optional custom filters to apply to the client contact, including various text and numeric filters for additional classification or segmentation.

Output

JSON

  • json - The JSON response from the Beex API representing the created client contact details.

Dependencies

  • Beex Contact Center API
  • API key credential for authentication

Troubleshooting

  • Common errors include invalid or missing parameters, which result in error messages returned from the Beex API. Ensure all required fields such as Portfolio ID, First Name, and Paternal Surname are provided.
  • API request failures may occur due to network issues or invalid API keys. Verify the API key credential and network connectivity.
  • Rate limiting or timeout errors may occur if too many requests are sent in a short period. The node includes a delay between requests to mitigate this.

Links

Discussion