Beex icon

Beex

Beex Contact Center API Interaction and Consumption

Client → Update One

AI-generated

Overview

This node updates an existing client contact on the Beex Contact Center platform by specifying the client ID and providing updated contact details. It is useful for scenarios where client information needs to be modified, such as correcting names, updating custom fields, or changing filters associated with the client. For example, a user can update a client's first name, paternal surname, and various custom fields like birthdate, job position, or salary.

Use Case Examples

  1. Updating a client's first name and paternal surname by providing the client ID and new values.
  2. Modifying custom fields such as document number, birthdate, and city for a specific client.
  3. Applying custom filters to a client contact during the update process.

Properties

Name Meaning
Client ID The unique identifier of the client to update. Required to specify which client record to modify.
First Name The updated first name of the client contact. Required for the update operation.
Paternal Surname The updated paternal surname (father's last name) of the client contact. Required for the update operation.
Custom Fields A collection of optional custom fields to update additional client contact details such as maternal surname, document number, birthdate, age, sex, civil state, job position, country, city, salary, workplace, and various text and numeric custom fields.
Custom Filters A collection of optional custom filters to apply during the update, including various text and numeric filter fields.

Output

JSON

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

Dependencies

  • Beex Contact Center API with an API key credential

Troubleshooting

  • Common issues include invalid or missing parameters, which result in error messages from the Beex API. Ensure that the Client ID is correctly specified and that required fields like First Name and Paternal Surname are provided.
  • API request failures may occur due to network issues or invalid API key credentials. Verify the API key and network connectivity.
  • Error messages from the API are parsed and presented with details to help identify the cause. Review the error message and description for guidance on resolving issues.

Discussion