...
The endpoint server address will be provided by TForgeService Delivery.
Use the following endpoint to initiate your request:
...
API key will be provided by TForgeService Delivery.
To access the Lead Dearchive API, you must authenticate using an API key.
...
Field | Datatype | Description |
|---|---|---|
insert_leads | true | false | This feature enables the insertion of specified lead IDs into the vicidial_list table. Lead IDs that are already present in the vicidial_list table will not be inserted again. It is recommended to always set this feature to true. |
delete_leads | true | false | This feature enables the deletion of specified lead IDs from the vicidial_list_archive table in a safe manner. Before deleting, the API checks if the specified lead IDs exists in the vicidial_list table and the column data matches the vicidial_list_archive table lead ID data. Setting this feature to false will result in lead IDs remaining in the vicidial_list_archive table. |
lead_ids | Integer | Specify the lead IDs that you wish to dearchive. The lead IDs limit is set by TForge. Ensure that the number of lead ID values does not exceed the set limit. Default limit is 500 valuesLimited to 500 leads per request. |
CURL request example:
For testing, create a dummy list and load 500 leads.
Use created lead IDs and archive leads using the Lead Archive API.
...
| Code Block | ||
|---|---|---|
| ||
curl -k -X POST https://server<server>/vicidial/leads/dearchive \ -H "Authorization: Key=YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "insert_leads": true, "delete_leads": true, "lead_ids": [ 0, 1 ] }' |
...