POST /api/v1/profile/delete/

Supprimer un profil

Efface les données personnelles d'un profil et annule ses e-mails planifiés. Utilisez cette opération pour répondre à une demande de droit à l'effacement.

Identifiez le profil par external_profile_id, customer_user_id ou email — envoyez au moins l'un d'eux. Adapty Mail associe les personnes par adresse e-mail, donc un email que vous envoyez est le seul identifiant utilisé ; omettez-le et c'est l'external_profile_id ou le customer_user_id qui permet de retrouver le profil.

La suppression efface les données stockées, mais elle ne bloque pas l'adresse. Une requête Enregistrer un profil ultérieure crée un nouveau profil, sans aucun historique du profil supprimé. Pour exclure définitivement quelqu'un, cessez d'envoyer ses données.

Répéter une suppression par external_profile_id ou customer_user_id réussit à nouveau sans rien modifier. Répéter une suppression qui ne comportait que l'email renvoie 404 : l'effacement supprime l'adresse stockée, de sorte qu'un e-mail ne trouve plus rien à faire correspondre.

Request body

Identifiants du profil à supprimer. Envoyez au moins un des champs external_profile_id, customer_user_id ou email.

external_profile_idstring

L'identifiant que vous avez envoyé lors de l'enregistrement du profil.

customer_user_idstring

L'identifiant de l'utilisateur dans votre propre système.

emailstring

L'adresse e-mail associée au profil.

Responses

Profil supprimé. La réponse ne contient pas de corps.

Aucun identifiant n'a été fourni.

Schema

Réponse d'erreur standard. Chaque échec renvoie un statut 4XX avec cette structure.

errorsarray of object
messagestring

Description de l'erreur lisible par un humain.

error_codestring

Identifiant d'erreur lisible par une machine.

status_codeinteger

Code de statut HTTP pour cette erreur.

field_namestring

Le champ de la requête à l'origine de l'erreur, ou null si l'erreur n'est pas liée à un champ spécifique.

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
    }
  ]
}

Clé API secrète manquante ou invalide.

Schema

Réponse d'erreur standard. Chaque échec renvoie un statut 4XX avec cette structure.

errorsarray of object
messagestring

Description de l'erreur lisible par un humain.

error_codestring

Identifiant d'erreur lisible par une machine.

status_codeinteger

Code de statut HTTP pour cette erreur.

field_namestring

Le champ de la requête à l'origine de l'erreur, ou null si l'erreur n'est pas liée à un champ spécifique.

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

Aucun profil ne correspond aux identifiants envoyés.

Schema

Réponse d'erreur standard. Chaque échec renvoie un statut 4XX avec cette structure.

errorsarray of object
messagestring

Description de l'erreur lisible par un humain.

error_codestring

Identifiant d'erreur lisible par une machine.

status_codeinteger

Code de statut HTTP pour cette erreur.

field_namestring

Le champ de la requête à l'origine de l'erreur, ou null si l'erreur n'est pas liée à un champ spécifique.

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