Contacts : listes

Définir l'abonnement à une liste

Désabonnez jusqu'à 500 contacts d'une liste, ou réabonnez-les, sans toucher à leurs autres listes ni à leur statut global.

POSThttps://g.sendcorex.com/v1/contactscommand: set_list_subscription
i

Nécessite le scope contact:update sur votre API key.

i

Les contacts qui ne sont pas membres de la liste restent inchangés et reviennent avec changed: false. Utilisez d'abord Add To Lists pour en faire des membres.

Arguments

  • emailsstring[]facultatif

    Jusqu'à 500 emails. La casse et les espaces autour sont ignorés, et les emails répétés ne comptent qu'une fois.

  • emailstringfacultatif

    Un seul email. Utilisez ceci ou emails.

  • list_idstringobligatoire

    La liste.

    ex. : "newsletter"

  • subscribedbooleanobligatoire

    false pour désabonner de cette liste, true pour réabonner.

  • return_contactsbooleanfacultatif

    Ajoute à chaque élément le contact complet après la modification.

Démarrage rapide

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "set_list_subscription",
        args: {
          emails: [
            "bob@gmail.com"
          ],
          list_id: "newsletter",
          subscribed: false
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);

const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);

Réponse

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "set_list_subscription",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "items": [
          {
            "id": "bob@gmail.com",
            "ok": true,
            "data": {
              "changed": true
            }
          }
        ],
        "ok_count": 1,
        "failed_count": 0
      }
    }
  ]
}

Champs de la réponse

  • items[].id

    L'email envoyé, tel que vous l'avez envoyé.

  • items[].ok

    true quand cet email a réussi. Si false, l'élément contient code et message.

  • items[].data.changed

    false signifie que le contact était déjà ainsi : rien n'a été écrit.

  • items[].data.contact

    Le contact complet après la modification. Uniquement avec return_contacts: true.

  • ok_count / failed_count

    Combien d'emails ont réussi et combien ont échoué.

Abonnement à la liste ou statut global ?

  • Set List Subscription

    La personne veut toujours vos autres listes. Elle reste membre ici, marquée comme désabonnée, et n'est plus joignable que dans cette liste.

  • Set Status

    La personne ne veut plus aucun email, ou l'adresse a généré un bounce. Sendable passe à false dans toutes les listes.

Erreurs

Les erreurs au niveau HTTP renvoient type, code et message. Les erreurs marquées CMD reviennent dans le résultat de la commande, avec HTTP 200.

  • 401INVALID_API_KEY

    L'API key n'existe pas, a été révoquée ou désactivée dans le dashboard.

  • 429RATE_LIMITED

    Plus de 15 requêtes/s ou 15 simultanées pour la même IP + API key. Attendez le nombre de secondes indiqué dans Retry-After.

  • CMDMISSING_SCOPE

    L'API key n'a pas le scope requis par cette commande. Les autres commandes de la requête s'exécutent quand même.

  • CMDINVALID_ARGS

    Un argument obligatoire est manquant ou invalide : email, valeur de champ, option d'enum, clé de where, id de liste…

  • CMDNOT_FOUND

    Le contact, la liste, le champ ou le segment n'existe pas.

  • CMDINTERNAL

    Erreur serveur. Le détail n'est écrit que dans le log du serveur.