Overview
The Vicidial Lead Archive API facilitates the archiving of leads within the Vicidial system.
Endpoint
| Infonote |
|---|
The API will be set by TForge to operate outside of office hours only. |
The endpoint server address will be provided by TForgeService Delivery.
Use the following endpoint to initiate your request:
Method | Endpoint | Description |
|---|---|---|
POST | /vicidial/leads/archive | Lead archive endpoint |
Authentication
API key will be provided by TForgeService Delivery.
To access the Lead Archive API, you must authenticate using an API key.
...
| Code Block |
|---|
Authorization: Key=YOUR_API_KEY Content-Type: application/json |
Request
| Info |
|---|
The API consistently executes operations in the following sequential order:
|
...
Field | Datatype | Description |
|---|---|---|
insert_leads | true | false | This feature enables the insertion of specified lead IDs into the vicidial_list_archive table. Lead IDs that are already present in the vicidial_list_archive table will not be inserted again. Use update_leads to ensure the specified lead IDs data is synchronized for lead IDs that were not inserted into vicidial_list_archive table. It is recommended to always set this feature to true. |
update_leads | true | false | This feature enables the updation of specified lead IDs. If a lead ID is already present in the vicidial_list_archive table, the API will update the lead ID data with the most recent matching lead ID information retrieved from the vicidial_list table. It is recommended to always set this feature to true for lead ID data synchronization. |
delete_leads | true | false | This feature enables the deletion of specified lead IDs from the vicidial_list table in a safe manner. Before deleting, the API checks if the specified lead IDs exists in the vicidial_list_archive table and the column data matches the vicidial_list table lead ID data. Setting this feature to false will result in lead IDs remaining in the vicidial_list table. |
lead_ids | Integer | Specify the lead IDs that you wish to archive. 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.
...
| Code Block | ||
|---|---|---|
| ||
curl -k -X POST https://server<server>/vicidial/leads/archive \ -H "Authorization: Key=YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "insert_leads": true, "update_leads": true, "delete_leads": true, "lead_ids": [ 0, 1 ] }' |
Response
| Info |
|---|
The API follows general HTTP response status codes. In addition to the HTTP code included in the JSON response, you can also rely on the HTTP status code returned by the response. |
| Tip |
|---|
HTTP status code - 200 |
Returns the following successful response If there are no errors with the request or the specified lead IDs. The data will be processed based on the option values specified in the request JSON object.
| Code Block | ||
|---|---|---|
| ||
{
"message": "lead_ids batch was successfully processed",
"select_count": 1,
"insert_count": 1,
"update_count": 0,
"delete_count": 1
} |
| Warning |
|---|
HTTP status code - 401 |
Returns the following error response if the API cannot validate the API user.
| Code Block | ||
|---|---|---|
| ||
{
"message": "unable to validate api user"
} |
| Warning |
|---|
HTTP status code - 403 |
Returns the following error response if the API was executed during office hours.
| Code Block | ||
|---|---|---|
| ||
{
"message": "api cannot be executed during office hours time condition"
} |
| Warning |
|---|
HTTP status code - 400 |
Returns the following error response if the value passed for insert_leads is not a bool value or no value was provided.
...
| Code Block | ||
|---|---|---|
| ||
{
"message": "lead_ids does not exist",
"lead_errors": 1,
"lead_ids": [
0
]
} |
| Warning |
|---|
HTTP status code - 500 |
Returns the following error response for any other errors not mentioned above.
...