URL:
https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=clear_campaign&type_campaign={{type_campaign}}&campaign_id={{campaign_id}}
Description:
With this API it is possible to delete all records in a campaign in bulk.
Benefit:
This function allows you to easily delete all the records of a campaign, and then reuse it with the parameterization that it has and then make a massive upload of records.
How it works:
- The consumption of this API is done by DELETE method.
- 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.
| REQUEST |
| NAME | DESCRIPTION | TYPE |
|---|---|---|
| type_campaign (URL) | Type of campaign | String |
| campaign_id (URL) | Refers to the numerical identification of the campaign. | String |
| RESPONSE |
| NAME | DESCRIPTION | TYPE |
|---|---|---|
| code | Response code | int |
| error | Error | String |
| msg | Description of the response | String |