Beex icon

Beex

Beex Contact Center API Interaction and Consumption

Lead → Create One

AI-generated

Overview

This node interacts with the Beex Contact Center API to create a new lead in the system. It is useful for automating the process of adding potential customer leads to a campaign or portfolio, including details such as customer code, portfolio ID, sequence ID, country code, phone number, email, priority, and additional optional parameters like first name and surnames. This can be applied in scenarios where businesses want to streamline lead management and integrate lead creation into their workflows.

Use Case Examples

  1. Automatically create leads from a web form submission by sending customer details to the Beex platform.
  2. Batch import multiple leads into a campaign portfolio with detailed contact and priority information.

Properties

Name Meaning
Customer Code Unique identifier for the customer, required to create a lead.
Portfolio ID ID of the campaign portfolio to which the lead belongs, required for lead creation.
Sequence ID Optional sequence identifier associated with the lead.
Country Code Country dialing code for the lead's phone number, required for contact.
Phone Number Phone number of the lead, required for contact.
Email Email address of the lead, optional for contact.
Priority Priority level of the lead, required to indicate importance.
Additional Parameters Optional additional fields such as first name, paternal surname, and custom text fields to provide more lead details.

Output

JSON

  • json - The response from the Beex API after creating a lead, containing details of the created lead or error information.

Dependencies

  • Beex API key credential required for authentication.

Troubleshooting

  • Common errors include invalid or missing parameters, which result in error messages from the Beex API. Ensure all required fields are correctly filled.
  • API request failures may occur due to network issues or invalid API keys; verify the API key and network connectivity.
  • Rate limiting is handled by a 1-second delay between requests; avoid sending too many requests in a short time to prevent throttling.

Links

Discussion