...
When making a request, you must post the following JSON object.
JSON object.
| Code Block | ||
|---|---|---|
| ||
{
"insert_leads": true,
"update_leads": true,
"delete_leads": true,
"lead_ids": [
12345,
67890
]
} |
JSON Object key | Datatype | Description |
|---|---|---|
insert_leads | true|false | This feature facilitates the insertion of leads into the vicidial_list_archive table. Leads that are already present in the vicidial_list_archive table will not be inserted again. Use update_leads to ensure the lead data is synchronized for leads that were not inserted. It is recommended to always set this feature to Truetrue. |
update_leads | true|false | If a lead is already present in the vicidial_list_archive table, the API will update the lead data with the most recent information retrieved from the vicidial_list table. It is recommended to always set this feature to True true for optimal data synchronization. |
delete_leads | true|false | This feature enables the deletion of leads from the vicidial_list table in a safe manner. Before deleting, the API checks if the lead exists in the vicidial_list_archive table. It is advisable to enable this feature only if both insert_leads and update_leads are set to true. Setting this feature to False false will result in leads remaining in the vicidial_list table. |
lead_ids | Interger values | Specify the lead IDs that you wish to archive. Ensure that the number of lead ID values does not exceed 500. |
API always runs operations in the following sequential order.
insert_leads
update_leads
delete_leads
The below CURL request example actions the following:
...