Vicidial Lead Dearchive API Documentation

Overview

The Vicidial Lead Dearchive API facilitates the dearchiving of leads within the Vicidial system.

Endpoint

Use the following endpoint to initiate your request:

Authentication

To access the Lead Dearchive API, you must authenticate using an API key.

Include the following headers in your request:

Authorization: Key=YOUR_API_KEY
Content-Type: application/json

Request

When making a request, you must post the following JSON object.

{
  "insert_leads": true,
  "delete_leads": true,
  "lead_ids": [
    0,
    1
  ]
}

CURL request example:

1. Insert lead IDs into the vicidial_list table. Ignore lead IDs that already exist in the vicidial_list table.

2. Delete lead IDs from the vicidial_list_archive table. Performs safe delete by checking if the lead IDs exist in the vicidial_list table and if the column data matches the vicidial_list_archive table lead ID.

curl -k -X POST https://<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
      ]
    }'

Response

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.

{
  "message": "lead_ids batch was successfully processed",
  "select_count": 1,
  "insert_count": 1,
  "delete_count": 1
}

Returns the following error response if the API cannot validate the API user.

{
  "message": "unable to validate api user"
}

Returns the following error response if the API was executed during office hours.

{
  "message": "api cannot be executed during office hours time condition"
}

Returns the following error response if the value passed for insert_leads is not a bool value or no value was provided.

{
  "message": "insert_leads must be a boolean value",
  "lead_errors": 0,
  "lead_ids": []
}

Returns the following error response if the value passed for delete_leads is not a bool value or no value was provided.

{
  "message": "delete_leads must be a boolean value",
  "lead_errors": 0,
  "lead_ids": []
}

Returns the following error response if the value passed for lead_ids is not an integer value or was passed with double quotes.

{
  "message": "lead_ids must only contain integer values",
  "lead_errors": 1,
  "lead_ids": [
    "0"
  ]
}

Returns the following error response if no value was passed for lead_ids.

{
  "message": "lead_ids must contain atleast 1 value",
  "lead_errors": 0,
  "lead_ids": []
}

Returns the following error response if the values passed for lead_ids exceed 500 values.

{
  "message": "lead_ids cannot exceed 500 values",
  "lead_errors": 0,
  "lead_ids": []
}

Returns the following error response if the values passed for lead_ids contain duplicate values.

{
  "message": "lead_ids cannot contain duplicate values",
  "lead_errors": 1,
  "lead_ids": [
    0
  ]
}

Returns the following error response if the values passed for lead_ids do not exist in the vicidial_list table.

{
  "message": "lead_ids does not exist",
  "lead_count": 1,
  "lead_ids": [
    0
  ]
}

Returns the following error response for any other errors not mentioned above.

{
  "message": "Unexpected character encountered while parsing number: s. Path 'lead_ids[97]', line 104, position 5.",
  "lead_errors": 0,
  "lead_ids": []
}