Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 matching lead ID exists in the vicidial_list_archive table and the data matches the vicidial_list table lead ID data.

Setting this feature to false will result in specified lead IDs remaining in the vicidial_list table.

lead_ids

Integer values

Specify the lead IDs that you wish to archive. Ensure that the number of lead ID values does not exceed 500.

...

Code Block
languagejson
{
  "error": "specified lead_ids does not exist",
  "lead_count": 1,
  "values": [
    0
  ],
  "status_code": 439
}

...

Code Block
languagejson
{
  "error": "api cannot be executed during specified office hours time condition",
  "status_code": 441
}

...