Suppressions de courriel

Lister les adresses courriel supprimées

Réponses

• 200Une page de suppressions du mode de la clé appelante, de la plus récente à la plus ancienne.›

  Champ	Type	Description
  data[]obligatoire	object[]
  email_addressobligatoire	string
  reasonobligatoire	string	Une valeur parmi : hard_bounce | complaint | unsubscribe | manual
  sourceobligatoire	string	Ce qui l’a ajoutée : ses_bounce, ses_complaint, unsubscribe ou manual.
  metadataobligatoire	any	Ce qui l’a enregistrée, comme l’identifiant du courriel d’un rebond ; null pour un blocage manuel.
  created_atobligatoire	string	Format : date-time
  livemodeobligatoire	boolean	false pour un enregistrement fait ou lu avec une clé de test (un enregistrement en mode test), true pour un enregistrement de production.
  has_moreobligatoire	boolean
  next_cursorobligatoire	string	Peut être null
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
• 422VALIDATION_ERROR : la requête n’a pas passé la validation ; details indique les champs en cause.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { data, error } = await honkio.suppressions.list({ reason: 'hard_bounce' })
if (error) throw new Error(error.message)
for (const s of data.data) console.log(s.email_address, s.created_at)

curl https://api.honkio.ca/v1/email-suppressions \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Ajouter une adresse courriel à la liste de suppression

Corps de la requête

Réponses

• 200L’adresse était déjà supprimée par le destinataire (un désabonnement ou une plainte pour pourriel) : l’entrée est gardée telle quelle, avec son propre motif, et aucun blocage manuel n’est ajouté.›

  Champ	Type	Description
  email_addressobligatoire	string
  reasonobligatoire	string	Une valeur parmi : unsubscribe | complaint
  livemodeobligatoire	boolean	false pour un enregistrement fait ou lu avec une clé de test (un enregistrement en mode test), true pour un enregistrement de production.
• 201L’adresse supprimée, en minuscules. Une clé de test l’ajoute à la liste de test, à laquelle seuls les envois de test sont confrontés.›

  Champ	Type	Description
  email_addressobligatoire	string
  reasonobligatoire	string	Une valeur parmi : manual
  livemodeobligatoire	boolean	false pour un enregistrement fait ou lu avec une clé de test (un enregistrement en mode test), true pour un enregistrement de production.
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403FORBIDDEN : la clé ne dispose pas de la permission requise par cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
• 422VALIDATION_ERROR : la requête n’a pas passé la validation ; details indique les champs en cause.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { error } = await honkio.suppressions.create({ emailAddress: 'sam@example.com' })
if (error) throw new Error(error.message)

curl -X POST https://api.honkio.ca/v1/email-suppressions \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email_address": "sam@example.com",
    "reason": "manual"
  }'

Retirer une adresse de la liste de suppression

Paramètres

Réponses

• 204Retirée : l’adresse peut de nouveau recevoir des courriels du mode de la clé.
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403FORBIDDEN : la clé ne dispose pas de la permission requise par cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
• 404NOT_FOUND (details.resource "email_suppression") : l’adresse n’est pas dans la liste de suppression du mode de la clé.Le corps d’erreur standard.
• 409EMAIL_SUPPRESSION_NOT_REMOVABLE : le destinataire s’est désabonné ou a signalé votre courriel comme pourriel (le motif de la suppression est unsubscribe ou complaint, ou l’adresse a un désabonnement courriel au dossier), ce que seul le destinataire peut annuler. Les autres suppressions manual et hard_bounce peuvent être retirées.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { error } = await honkio.suppressions.remove('sam@example.com')
if (error) throw new Error(error.message)

curl -X DELETE https://api.honkio.ca/v1/email-suppressions/ADDRESS \
  -H "Authorization: Bearer mk_live_YOUR_KEY"