3. Delete all records of a campaign -

< / >

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.
You can filter the deletion of records by result. It can accept the following values: “no-answer”, “answer-machine”, “abandon”, “busy”, “congestion”, “unknown”, “failed”, “do-not-call”, “chanunavail”, and “answer”.
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

NAME	DESCRIPTION	TYPE
type_campaign (URL)	Type of campaign	String
campaign_id (URL)	Refers to the numerical identification of the campaign.	String
result	This optional field in the API URL allows you to delete records that have a specific value in their result column. It can accept the following values: “no-answer”, “answer-machine”, “abandon”, “busy”, “congestion”, “unknown”, “failed”, “do-not-call”, “chanunavail”, and “answer”.	String

Response

NAME	DESCRIPTION	TYPE
code	Response code	int
error	Error	String
msg	Description of the response	String

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_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location --globoff --request DELETE 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=clear_campaign&type_campaign={{type_campaign}}&campaign_id={{campaign_id}}' \
--header 'wolkvox_server: {{wolkvox_server}}' \
--header 'wolkvox-token: {{wolkvox-token}}' \
--data ''

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=clear_campaign&type_campaign={{type_campaign}}&campaign_id={{campaign_id}}")
  .method("DELETE", body)
  .addHeader("wolkvox_server", "{{wolkvox_server}}")
  .addHeader("wolkvox-token", "{{wolkvox-token}}")
  .build();
Response response = client.newCall(request).execute();

				
					import requests

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

payload = ""
headers = {
  'wolkvox_server': '{{wolkvox_server}}',
  'wolkvox-token': '{{wolkvox-token}}'
}

response = requests.request("DELETE", url, headers=headers, data=payload)

print(response.text)

RESPONSE

				
					{
    "code": 202,
    "error": null,
    "msg": "All records has been deleted of campaign_id xxxxx successfully"
}

wolkvox
worldwide

UNITED STATES

Atlanta, GA +1 (470) 447-2610
Miami, FL +1 (470) 447-2610

ARGENTINA

Buenos Aires +54 (11) 5217 5933

BRAZIL

Sao Paulo +55 (11) 521 75 933

CHILE

Santiago de Chile +56 (2) 240 533 89

SPAIN

Madrid +34 (910) 601 691

COLOMBIA

Medellín +57 (604) 322 98 80

GUATEMALA

Ciudad de Guatemala +502 (2) 3141344

MEXICO

Ciudad de México +52 (55) 8526 36 34

DOMINICAN REPUBLIC

Santo Domingo +1 (829) 249 69 68

PERU

Lima +51 (1) 644 91 39

|

Information security policy

|

|

Information Transfer Policies

Copyright © 2025 WOLKVOX MICROSYSLABS. 1820 N Corporate Lakes Blvd, unit 205. Weston, FL 33326

Nosotros

OMNICHANNEL PLATFORM

CHATBOTS AND VOICEBOTS

wolkvox worldwide

COLOMBIA
Medellín +57 (4) 322 98 80
Bogotá +57 (1) 381 90 40
Cali +57 (2) 891 28 46
Barranquilla +57 (5) 316 10 34

ARGENTINA
Buenos Aires +54 (11) 5217 5933

SPAIN
Madrid +34 (910) 601 691

MEXICO
Ciudad de México +52 (55) 8526 36 34

BRASIL
Brasilia +55 (61) 9836 4127
São Paulo +55 (12) 9811 155 83

UNITED STATES
New York +1 (914) 373 71 36

DOMINICAN REPUBLIC
Santo Domingo +1 (829) 249 69 68

CHILE
Santiago de Chile +56 (2) 240 533 89

GUATEMALA
Ciudad de Guatemala +502 (2) 314 1344

PERU
Lima +51 (1) 644 91 39

Information security policy

Information Transfer Policies

Copyright © 2025 WOLKVOX MICROSYSLABS.
Cra 30 # 4A – 45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia