logoDocumentación
Buscar

API para eliminar usuarios

Requisito previo

Una vez que se elimina un usuario, no se puede restaurar. Los usuarios eliminados solo pueden volver a recibir mensajes en los siguientes escenarios:

  • Web: Borrar las cookies del navegador y, a continuación, volver a su sitio web.
  • Móvil: Abrir la aplicación de nuevo o desinstalar y reinstalarla para reinicializar el SDK. Se recomienda actualizar a la versión más reciente del SDK en la aplicación.

Recomendaciones antes de la eliminación

  1. Consultar información de etiquetas y alias: Utilizar la API de etiquetas y alias para consultar los alias y las etiquetas actualmente vinculados al registration_id que se va a eliminar.

  2. Verificar la audiencia: Verificar cuidadosamente la audiencia que se va a eliminar.

    ❗️Advertencia: No eliminar a todos los usuarios. Actuar con la máxima precaución al realizar estos pasos para garantizar que no se eliminen todos los usuarios.

Descripción de la API para eliminar usuarios

Esta API se utiliza para eliminar un usuario existente (registration_id). Se eliminarán todos los datos relacionados, las etiquetas vinculadas, los alias, la información del dispositivo y la información de zona horaria. Esta eliminación se realiza de forma asíncrona.

Endpoint

DELETE /v4/devices/{registration_id}
              
              DELETE /v4/devices/{registration_id}

            
Este bloque de código se muestra en una ventana flotante

Encabezado de la solicitud

DELETE /v4/devices/{registration_id} Authorization: Basic (base64 auth string) Accept: application/json
              
              DELETE /v4/devices/{registration_id}
Authorization: Basic (base64 auth string)
Accept: application/json

            
Este bloque de código se muestra en una ventana flotante

Parámetros de la solicitud

Nombre Obligatorio Descripción
ID de registro (registration_id) Identificador único del dispositivo en el sistema de EngageLab. No se admite la eliminación por lotes.

Ejemplo de solicitud

DELETE /v4/devices/abc123 Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l Accept: application/json
              
              DELETE /v4/devices/abc123
Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l
Accept: application/json

            
Este bloque de código se muestra en una ventana flotante

Ejemplo de respuesta

Respuesta correcta

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "success": true }
              
              HTTP/1.1 200 OK 
Content-Type: application/json; charset=utf-8
{
  "success": true
}

            
Este bloque de código se muestra en una ventana flotante

Respuesta de error

{ "error":{ "code":27002, "message":"unknown error" } }
              
              {
  "error":{
    "code":27002, 
    "message":"unknown error"
    }
}

            
Este bloque de código se muestra en una ventana flotante
Icon Solid Transparent White Qiyu
Contacto