...
Method | Endpoint | Description |
|---|
POST | /vicidial/leadleads/dearchive | Lead dearchive endpoint |
...
| Code Block |
|---|
|
{
"message": "lead_ids batch was successfully processed",
"select_count": 1,
"insert_count": 1,
"delete_count": 1,
"http_code": 200
} |
| Warning |
|---|
HTTP status code - 401 |
...
| Code Block |
|---|
|
{
"message": "unable to validate api user",
"http_code": 401
} |
| Warning |
|---|
HTTP status code - 403 |
...
| Code Block |
|---|
|
{
"message": "api cannot be executed during office hours time condition",
"http_code":
403
} |
| Warning |
|---|
HTTP status code - 400 |
...
| Code Block |
|---|
|
{
"message": "insert_leads must be a boolean value",
"http_codelead_errors": 0,
"lead_ids": 400[]
} |
Returns the following error response if the value passed for delete_leads is not a bool value or no value was provided.
| Code Block |
|---|
|
{
"message": "delete_leads must be a boolean value",
"lead_errors": 0,
"httplead_codeids": 400[]
} |
Returns the following error response if the value passed for lead_ids is not an integer value or was passed with double quotes.
| Code Block |
|---|
|
{
"message": "lead_ids must only contain integer values",
"lead_counterrors": 1,
"lead_ids": [
"0"
],
"http_code": 400
} |
Returns the following error response if no value was passed for lead_ids.
| Code Block |
|---|
|
{
"message": "lead_ids must contain atleast 1 value",
"http_code"lead_errors": 0,
"lead_ids": 400[]
} |
Returns the following error response if the values passed for lead_ids exceed 500 values.
| Code Block |
|---|
|
{
"message": "lead_ids cannot exceed 500 values",
"lead_errors": 0,
"httplead_codeids": 400[]
} |
Returns the following error response if the values passed for lead_ids contain duplicate values.
| Code Block |
|---|
|
{
"message": "lead_ids cannot contain duplicate values",
"lead_counterrors": 1,
"lead_ids": [
0
],
"http_code": 400
} |
Returns the following error response if the values passed for lead_ids do not exist in the vicidial_list table.
| Code Block |
|---|
|
{
"message": "lead_ids does not exist",
"lead_count": 1,
"lead_ids": [
0
],
"http_code":
400
} |
| Warning |
|---|
HTTP status code - 500 |
...
| Code Block |
|---|
|
{
"message": "Unexpected character encountered while parsing number: s. Path 'lead_ids[97]', line 104, position 5.",
"http_codelead_errors": 0,
"lead_ids": 500
} |
Conclusion
...