Eliminar un contacto de una lista estática mediante API

Esta API permite eliminar un contacto de una lista estática de DataCrush.

La operación únicamente elimina la relación entre el contacto y la lista seleccionada. El contacto seguirá existiendo dentro del portal y conservará toda su información.

¿Qué hace esta API?

Cuando la solicitud se procesa correctamente:

• El contacto deja de pertenecer a la lista indicada.
• El contacto permanece activo dentro del portal.
• Se actualiza automáticamente la cantidad de contactos de la lista.
• Pueden ejecutarse automatizaciones configuradas con el disparador de salida de lista.

Esta API solo funciona con listas de tipo estático.

Requisitos previos

Antes de utilizar este endpoint debes contar con:

Portal ID

Identificador numérico de tu portal en DataCrush.

API Key

Clave de acceso obtenida desde la configuración del portal o del usuario.

Lista estática

Debes identificar la lista de una de las siguientes formas:

• Mediante el ID de la lista (list_id).
• Mediante el nombre exacto de la lista (name).

Si envías ambos valores, DataCrush utilizará el nombre para resolver automáticamente el ID correspondiente.

Contacto

El contacto debe existir en el portal y encontrarse activo.

Puedes identificarlo utilizando:

• contact_key
• email

Si envías ambos valores, se utilizará prioritariamente contact_key.

Endpoint

POST https://api.datacrush.la/list/deleteContact

También es posible realizar solicitudes mediante POST utilizando el formato application/x-www-form-urlencoded.

La respuesta se devuelve en formato JSON.

Parámetros disponibles

portal_id: Identificador del portal. Obligatorio

api_key: API Key del portal o usuario. Obligatorio

list_id Identificador numérico de la lista. Obligatorio: Sí, salvo que se envíe name.

name: Nombre de la lista. Obligatorio: Sí, salvo que se envíe list_id.

contact_key: Clave única del contacto. Obligatorio: Sí, salvo que se envíe email.

email: Dirección de correo electrónico del contacto. Obligatorio: Sí, salvo que se envíe contact_key.

Ejemplo de solicitud utilizando list_id y contact_key

POST https://api.datacrush.la/list/deleteContact?portal_id=12345&api_key=TU_API_KEY&list_id=100&contact_key=abc-def-123

Ejemplo de solicitud utilizando nombre de lista y email

POST https://api.datacrush.la/list/deleteContact?portal_id=12345&api_key=TU_API_KEY&name=Newsletter%20VIP&email=contacto@ejemplo.com

Respuesta exitosa

Cuando la operación se realiza correctamente, la API devuelve:

{
  "result": "success"
}

No se devuelven datos adicionales.

Respuestas de error

Campos obligatorios faltantes

{
  "result": "fail",
  "error": {
    "code": 1,
    "message": "Campos obligatorios"
  }
}

Este error ocurre cuando no se informa una lista o un contacto válido.

Error de acceso

{
  "result": "fail",
  "error": {
    "code": 100
  }
}

Puede producirse cuando:

• El portal_id es incorrecto.
• La api_key es inválida.
• El portal o usuario se encuentran inactivos.

Límite de solicitudes excedido

{
  "result": "fail",
  "error": {
    "code": 101
  }
}

Indica que se superó el límite permitido de llamadas a la API.

Error de validación

{
  "result": "fail",
  "error": {
    "code": 200
  }
}

Ocurre cuando la eliminación no pudo completarse correctamente en la base de datos.

Contacto inexistente

{
  "result": "fail",
  "error": {
    "code": 303
  }
}

El contacto indicado no existe, está inactivo o fue eliminado.

Lista inválida

{
  "result": "fail",
  "error": {
    "code": 510
  }
}

La lista indicada:

• No existe.
• No es una lista estática.
• No coincide con el nombre enviado.

Límites y consideraciones

Límite de uso

La API comparte los límites generales del portal:

• Máximo 30 solicitudes por minuto.
• El límite es compartido con el resto de los endpoints API.

Solo listas estáticas

No es posible eliminar contactos de listas dinámicas, inteligentes o basadas en criterios mediante este endpoint.

El contacto no se elimina

La operación únicamente quita al contacto de la lista seleccionada.

Prioridad de identificadores

Si se envían múltiples identificadores:

• contact_key tiene prioridad sobre email.
• name tiene prioridad sobre list_id.

Si el contacto existe pero ya no pertenece a la lista, la operación puede devolver igualmente una respuesta exitosa.

Automatizaciones

La eliminación de un contacto puede disparar workflows asociados a eventos de salida de lista y actualizar integraciones conectadas a dicha lista.

Resumen

1. Obtén tu portal_id y api_key.
2. Identifica la lista mediante list_id o name.
3. Identifica el contacto mediante contact_key o email.
4. Realiza la llamada al endpoint.
5. Verifica que la respuesta devuelva result: success.