URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=remove_record&type_campaign={{type_campaign}}&campaign_id={{campaign_id}}

Description:

This API allows you to delete a record from the database of a predictive campaign, from an external platform.

Benefit:

This feature is useful when you have a campaign running but the customer contacts you through another channel.

How it works:

• The consumption of this API is done by DELETE method.
• In the json the parameters are added according to the operation or process to be performed.
• To consume this API you must replace in the url {{{wolkvox_server}} by the nomenclature of the server of the operation.
• The wolkvox-token header must be used to make use of the authorization token.
• Note that the same token cannot be consumed simultaneously, so you can schedule the next API to be consumed when the result of the previous one is successful.
• The search for the record to be deleted is based on the customer’s identification number or the value placed in “customer_id” when the record was uploaded.
• Deleting the record not only removes it from the active campaign but also from the contact attempt history in the reports, as long as the record has not been successfully contacted. That is, records with RESULT = “ANSWER” will not be deleted from the reports.
• Important: This action is irreversible. Once a record is deleted by this API, it is not possible to reverse the deletion or its effect on the reports.
• Limit of records that can be downloaded per consumption: 60,000 records.
• Limit of records that can be uploaded per consumption: 10,000 records.
• Limit of days queried in dates: 31 days.
• Limit of result weight: 256 MB.
• API consumption time limit: 60 seconds.
• Concurrent consumption limit of a token: 2 simultaneous requests.
• Daily limit of tokens: Number of licenses multiplied by 1000 daily tokens.

Request

Response