Contacts : listes

Créer une liste

Créez une liste. Choisissez votre propre id pour que votre code puisse y faire référence, ou laissez le serveur en générer un.

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

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

i

Une liste regroupe des contacts pour l'envoi. Le contact appartient au compte : l'ajouter à une liste ne le copie pas.

Arguments

  • list_idstringfacultatif

    Votre propre id : a-z, 0-9, _ et -, 40 caractères maximum. Généré s'il est omis. Un id déjà existant échoue avec ALREADY_EXISTS.

    ex. : "customers"

  • namestringfacultatif

    Nom affiché.

    ex. : "Customers"

  • descriptionstringfacultatif

    Texte libre affiché avec la liste.

  • sourcestringfacultatif

    D'où viennent les contacts, pour votre information.

    ex. : "checkout"

  • customobjectfacultatif

    Vos propres données, jusqu'à 50 clés.

    ex. : { "origin": "checkout", "year": 2026 }

Démarrage rapide

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "create_list",
        args: {
          list_id: "customers",
          name: "Customers",
          description: "Everyone who bought at least once",
          source: "checkout",
          custom: {
            origin: "checkout",
            year: 2026
          }
        }
      }
    ]
  },
  { 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": "create_list",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "list_id": "customers",
        "name": "Customers",
        "description": "Everyone who bought at least once",
        "source": "checkout",
        "status": "ready",
        "custom": {
          "origin": "checkout",
          "year": 2026
        },
        "created_at": "2026-10-01T10:00:00.000Z",
        "updated_at": "2026-10-12T15:22:41.000Z",
        "stats": {
          "total": 0,
          "ok": 0,
          "opened": 0,
          "clicked": 0
        }
      }
    }
  ]
}

Champs de la réponse

  • list_id

    L'id envoyé ou celui qui a été généré.

  • status

    ready.

  • stats

    Compteurs, tous à 0 pour une nouvelle liste.

Ensuite : la remplir

Envoyez list_id avec Upsert Contacts pour importer directement dans la liste, ou utilisez Add To Lists pour les contacts que vous avez déjà.

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…

  • CMDALREADY_EXISTS

    create_list a été appelé avec un list_id qui existe déjà.

  • CMDINTERNAL

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