Page Comparison

...

Base URL Endpoint

Use the following endpoint to initiate your request:

...

curl -k -X POST https://api.tforge.co.zaserver/vicidial/lead/archive/ \
-H "Authorization: Key=YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
      "insert_leads": true,
      "update_leads": true,
      "delete_leads": true,
      "lead_ids": [
        12345,
        67890
      ]
    }'

...

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 options specified in the JSON object.

{
  "success": "lead batch was successfully processed",
  "select_count": 1,
  "insert_count": 1,
  "update_count": 0,
  "delete_count": 1,
  "status_code": 200
}

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

{
  "error": "insert_leads must be a boolean value",
  "status_code": 432
}

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

{
  "error": "update_leads must be a boolean value",
  "status_code": 433
}

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

{
  "error": "delete_leads must be a boolean value",
  "status_code": 434
}

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

{
  "error": "lead_ids must only contain integer values",
  "lead_ids": [
    "56712"
  ],
  "status_code": 435
}

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

{
  "error": "lead_ids must contain atleast 1 value",
  "status_code": 436
}

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

{
  "error": "lead_ids cannot exceed 500 values",
  "status_code": 437
}

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

{
  "error": "lead_ids cannot contain duplicate values",
  "lead_ids": [
    12345
  ],
  "status_code": 438
}

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

{
  "error": "specified leads do not exist",
  "lead_count": 1,
  "values": [
    12345
  ],
  "status_code": 439
}

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

...