POST /api/v1/profile/delete/

Eliminar perfil

Borra los datos personales de un perfil y cancela sus emails programados. Úsalo para cumplir una solicitud de derecho al olvido.

Identifica el perfil mediante external_profile_id, customer_user_id o email — envía al menos uno. Adapty Mail busca a las personas por dirección de email, por lo que un email que envíes es el único identificador utilizado; si lo omites, el external_profile_id o el customer_user_id localizarán el perfil en su lugar.

La eliminación borra los datos almacenados, pero no bloquea la dirección. Una solicitud posterior de Guardar perfil crea un nuevo perfil, sin ningún historial del perfil eliminado. Para mantener a alguien fuera de forma permanente, deja de enviar sus datos.

Repetir una eliminación por external_profile_id o customer_user_id vuelve a tener éxito sin cambiar nada. Repetir una que solo contenía email devuelve 404: el borrado elimina la dirección almacenada, por lo que no queda nada con lo que hacer coincidir un email.

Request body

Identificadores del perfil a eliminar. Envíe al menos uno de external_profile_id, customer_user_id o email.

external_profile_idstring

El identificador que envió al guardar el perfil.

customer_user_idstring

El identificador del usuario en su propio sistema.

emailstring

La dirección de correo electrónico del perfil.

Responses

Perfil eliminado. La respuesta no tiene cuerpo.

No se proporcionó ningún identificador.

Schema

Respuesta de error estándar. Cada fallo devuelve un estado 4XX con esta estructura.

errorsarray of object
messagestring

Descripción del error en formato legible para humanos.

error_codestring

Identificador de error legible por máquina.

status_codeinteger

Código de estado HTTP para este error.

field_namestring

El campo de la solicitud que causó el error, o null si el error no está relacionado con un campo específico.

Example
{
  "errors": [
    {
      "message": "At least one of external_profile_id, customer_user_id or email must be provided",
      "error_code": "missing_identifier",
      "status_code": 400,
      "field_name": null
    }
  ]
}

Clave de API secreta ausente o no válida.

Schema

Respuesta de error estándar. Cada fallo devuelve un estado 4XX con esta estructura.

errorsarray of object
messagestring

Descripción del error en formato legible para humanos.

error_codestring

Identificador de error legible por máquina.

status_codeinteger

Código de estado HTTP para este error.

field_namestring

El campo de la solicitud que causó el error, o null si el error no está relacionado con un campo específico.

Example
{
  "errors": [
    {
      "message": "Secret key doesn't exist",
      "error_code": "secret_key_does_not_exist_error",
      "status_code": 403,
      "field_name": null
    }
  ]
}

Ningún perfil coincide con los identificadores enviados.

Schema

Respuesta de error estándar. Cada fallo devuelve un estado 4XX con esta estructura.

errorsarray of object
messagestring

Descripción del error en formato legible para humanos.

error_codestring

Identificador de error legible por máquina.

status_codeinteger

Código de estado HTTP para este error.

field_namestring

El campo de la solicitud que causó el error, o null si el error no está relacionado con un campo específico.

Example
{
  "errors": [
    {
      "message": "Profile not found",
      "error_code": "profile_not_found_error",
      "status_code": 404,
      "field_name": null
    }
  ]
}