fbpx

< / >

APIs Billing

3. Delete all records of a campaign

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.

NAMEDESCRIPTIONTYPE
type_campaign (URL)Type of campaignString
campaign_id (URL)Refers to the numerical identification of the campaign.String

NAMEDESCRIPTIONTYPE
codeResponse codeint
errorErrorString
msgDescription of the responseString

Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=clear_campaign&type_campaign={{type_campaign}}&campaign_id={{campaign_id}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'DELETE',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": 202,
    "error": null,
    "msg": "All records has been deleted of campaign_id xxxxx successfully"
}
				
			
We use cookies, if you continue browsing we will assume that you agree. You can read more about the use of cookies in our privacy policies and treatment of personal data