fbpx
Search
Close this search box.
Search
Close this search box.

< / >

APIs Campaign

8. Delete record

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.

REQUEST

NAME DESCRIPTION TYPE
type_campaign (URL) Campaign Type. This field can take the values “preview” or “predictive”. String
campaign_id (URL) Campaign ID Number. String
customer_id Refers to the numerical identification of the customer. 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=remove_record&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_POSTFIELDS =>'{
    "customer_id": ""
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": 202,
    "error": null,
    "msg": "customer_id xxxxxxxxxx has been deleted 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