Page Comparison

The API will operate outside of office hours only.

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

The API consistently executes operations in the following sequential order:

1. insert_leads

2. update_leads

3. delete_leads

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

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.

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

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

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

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