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

URL:

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

Description:

This API allows you to pause a campaign from an external platform.

Benefit:

This function is used to facilitate and speed up the process of activating or deactivating campaigns using a button, for example, from the platform where the management is being carried out.

How it works:

REQUEST

NAME DESCRIPTION TYPE
type_campaign (URL) Campaign type. This field can accept the values “preview” or “predictive”. String
campaign_id (URL) Campaign ID. String

RESPONSE

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

 

Possible response codes
				
					<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=stop&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 => 'PUT',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": 202,
    "error": null,
    "msg": "The xxxxx campaign_id has been stopped successfully"
}
				
			

URL:

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

Description:

This API allows you to pause a campaign from an external platform.

Benefit:

This function is used to facilitate and speed up the process of activating or deactivating campaigns using a button, for example, from the platform where the management is being carried out.

How it works:

NAME DESCRIPTION TYPE
type_campaign (URL) Campaign type. This field can accept the values “preview” or “predictive”. String
campaign_id (URL) Campaign ID. String

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

 

Possible response codes
				
					<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=stop&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 => 'PUT',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": 202,
    "error": null,
    "msg": "The xxxxx campaign_id has been stopped successfully"
}
				
			

URL:

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

Description:

This API allows you to pause a campaign from an external platform.

Benefit:

This function is used to facilitate and speed up the process of activating or deactivating campaigns using a button, for example, from the platform where the management is being carried out.

How it works:

NAME DESCRIPTION TYPE
type_campaign (URL) Campaign type. This field can accept the values “preview” or “predictive”. String
campaign_id (URL) Campaign ID. String

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

 

Possible response codes
				
					<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=stop&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 => 'PUT',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": 202,
    "error": null,
    "msg": "The xxxxx campaign_id has been stopped successfully"
}
				
			

< / >

APIs Campaign

11. Stop campaign En

URL:

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

Description:

This API allows you to pause a campaign from an external platform.

Benefit:

This function is used to facilitate and speed up the process of activating or deactivating campaigns using a button, for example, from the platform where the management is being carried out.

How it works:

  • The consumption of this API is done by PUT 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.

NAME DESCRIPTION TYPE
type_campaign (URL) Campaign type. This field can accept the values “preview” or “predictive”. String
campaign_id (URL) Campaign ID. String

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

 

Possible response codes
				
					<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=stop&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 => 'PUT',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": 202,
    "error": null,
    "msg": "The xxxxx campaign_id has been stopped 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