HonkIOHonkIO

Référence de l’API

Suppressions de courriel

Gérer les listes de suppression de courriels.

get/v1/email-suppressions

Lister les adresses courriel supprimées

Permissionemail_suppressions:rSDK Node.jshonkio.suppressions.list()

Du plus récent au plus ancien. Filtrez avec reason (hard_bounce, complaint, unsubscribe ou manual) et paginez avec limit (50 par défaut, jusqu’à 100) et cursor.

Nécessite email_suppressions:r.

Réponses

  • 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.
  • 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)
post/v1/email-suppressions

Ajouter une adresse courriel à la liste de suppression

Permissionemail_suppressions:wSDK Node.jshonkio.suppressions.create()

Ajoute l’adresse à la liste de suppression avec le motif manual. Un envoi à une adresse supprimée est refusé avec EMAIL_SUPPRESSED.

Nécessite email_suppressions:w.

Corps de la requête

L’adresse à bloquer.

ChampTypeDescription
email_addressobligatoirestring

L’adresse. Aucun courriel ne lui est plus envoyé tant que vous ne la retirez pas.

  • Format : email
reasonobligatoirestring

Toujours manual : les rebonds, les plaintes et les désabonnements sont ajoutés automatiquement.

  • Une valeur parmi : manual

Réponses

  • 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.
  • 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)
delete/v1/email-suppressions/{address}

Retirer une adresse de la liste de suppression

Permissionemail_suppressions:dSDK Node.jshonkio.suppressions.remove()

Répond 204, ou 404 si l’adresse n’est pas dans la liste de suppression.

Nécessite email_suppressions:d.

Paramètres

ParamètreTypeDescription
addressobligatoirecheminstring

Réponses

  • 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.
  • 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)