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

< / >

APIs Campaign

13. Eliminar campaña

URL:

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

Descripción:

Esta API eliminar campañas específicas de acuerdo con sus necesidades, ofreciendo una forma programática y eficiente de llevar a cabo esta acción. Puedes eliminar tanto campañas de tipo predictiva como preview.

Beneficio:

La API para eliminar campaña específica ofrece el beneficio de automatizar y simplificar la gestión de campañas al proporcionar a los usuarios una forma eficiente de eliminar campañas de manera programática. Esta automatización agiliza los procesos de limpieza y administración, permitiendo a los usuarios tomar decisiones informadas sobre la eliminación de campañas según sus necesidades. Sin embargo, es importante recordar que esta función irreversible requiere una evaluación cuidadosa para garantizar la preservación de datos importantes y la toma de decisiones conscientes en línea con los objetivos operativos.

Cómo funciona:

  • El consumo de esta API se realiza por método DELETE.
  • En el json se agregan los parámetros de acuerdo a la operación o proceso a realizar.
  • Para consumir esta API debe reemplazar en la url {{wolkvox_server}} por la nomenclatura del servidor de la operación.
  • Se debe hacer uso del header wolkvox-token: {{token}} para hacer uso de el token de autorización.
  • Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
  • Importante: Asegúrese de haber evaluado detenidamente si la campaña debe ser eliminada antes de consumir esta API. Esta acción no se puede deshacer, por lo que recomendamos verificar que no haya datos importantes que deban mantenerse.

REQUEST

NAME DESCRIPTION TYPE
type_campaign Aquí deberás especificar el tipo de campaña. Este campo puede aceptar los valores “preview” o “predictive”. String
campaign_id Se refiere al número de identificación de la campaña String

RESPONSE

NAME DESCRIPTION TYPE
code Código de respuesta int
error Error String
msg Descripción de la respuesta String

Posibles códigos de respuesta
				
					$curl = curl_init();

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

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "Campaign {{campaign_id}} has been deleted."
}
				
			

Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales

Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales