Eliminar contactos de campaña

Elimina todos los contactos de una campaña o solo algunos específicos mediante los filtros de búsqueda disponibles.

API de WhatsApp y CRM

Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.

DELETE https://api.getincloud.ai/v1/campaigns/{campaignId}/contacts

Elimina todos los contactos de una campaña o solo algunos específicos mediante los filtros de búsqueda disponibles.

Esta acción solo se puede realizar en campañas con estado draft o paused.

Si la campaña ya se está procesando o ya se completó, esta acción no está permitida.

Prueba este endpoint en el probador de API en vivo

>¿Necesitas ayuda? Explora todos los tutoriales, más de 100 ejemplos de casos de uso y juega con el probador de API en vivo con ejemplos de código listos para usar en más de 15 lenguajes de programación, incluidos JavaScript/Node.js, PHP, Python, C#, Java, Ruby, Swift, Kotlin, Powershell, cURL y más.

Autenticación

Envía tu API key en el encabezado Token en cada petición.

Cuerpo de la petición

Campo	Tipo	Obligatorio	Descripción
`wids`	array<string>	No	Elimina contactos de la campaña por ID de mensaje de WhatsApp (WID). Ejemplo: `3EB04FD61059A925F101A0`
`contacts`	array<string>	No	Elimina contactos de la campaña por ID de WhatsApp. Ejemplo: `1234567890@c.us` para usuarios o `123456789000000000@g.us` para grupos
`phones`	array<string>	No	Elimina contactos de la campaña por número de teléfono en formato E164. Ejemplo: `+1234567890`
`groups`	array<string>	No	Elimina contactos de la campaña por ID de WhatsApp del chat de grupo. Ejemplo: `123456789000000000@g.us`

Respuestas

Código	Descripción
`200`	Contactos eliminados correctamente
`400`	Datos de consulta o del cuerpo de la solicitud no válidos
`401`	No autorizado: token de API no válido o ausente
`403`	Faltan los permisos necesarios
`404`	Recurso no encontrado
`409`	La campaña ya no es editable
`429`	Demasiadas solicitudes: inténtalo de nuevo más tarde
`500`	Error inesperado
`501`	No implementado
`503`	Servicio no disponible temporalmente: inténtalo de nuevo más tarde

// This code example requires you to have installed curl package
// Installation instructions here: https://curl.haxx.se/download.html

// Delete all contacts in the campaign
curl --request DELETE \
  --url https://api.getincloud.ai/v1/campaigns/{id}/contacts \
  --header 'Token: <api token goes here>'


// Delete contacts by phone number in the campaign
curl --request DELETE \
  --url https://api.getincloud.ai/v1/campaigns/{id}/contacts \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"phones":["+1234567890","+1234567890","+1234567890"],"groups":["123456789000000000@g.us","123456789000000000@g.us"]}'


// Delete contacts by WhatsApp IDs in the campaign
curl --request DELETE \
  --url https://api.getincloud.ai/v1/campaigns/{id}/contacts \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"wids":["3EB03450462A256E81D0","3EB03450462A256E81D1","3EB03450462A256E81D2"]}'

AnteriorEliminar campaña SiguienteIniciar/detener campaña

¿Te sirvió esta página?