Contacts : segments

Enregistrer un segment

Enregistrez une requête sous un nom, pour que votre application et le dashboard puissent l'exécuter plus tard. Les contacts ne sont pas copiés : le segment est réévalué à chaque exécution.

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

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

i

Le where est validé à l'enregistrement : une clé ou un champ inconnu échoue avec INVALID_ARGS tout de suite, pas à la prochaine exécution.

Arguments

  • segment_idstringfacultatif

    Votre propre id. Généré s'il est omis. Enregistrer avec un id existant remplace ce segment.

    ex. : "engaged-vips"

  • namestringfacultatif

    Nom affiché.

    ex. : "Engaged VIPs"

  • whereobjectobligatoire

    Le même where que Query Contacts.

  • sortstring | objectfacultatif

    Le même sort que Query Contacts.

    ex. : "open_rate"

Démarrage rapide

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "save_segment",
        args: {
          segment_id: "engaged-vips",
          name: "Engaged VIPs",
          where: {
            tags: {
              has: "vip"
            },
            last_open_at: {
              within_days: 30
            }
          },
          sort: "open_rate"
        }
      }
    ]
  },
  { 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": "save_segment",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "segment_id": "engaged-vips",
        "name": "Engaged VIPs",
        "where": {
          "tags": {
            "has": "vip"
          },
          "last_open_at": {
            "within_days": 30
          }
        },
        "sort": {
          "field": "open_rate"
        },
        "created_at": "2026-10-10T12:00:00.000Z",
        "updated_at": "2026-10-10T12:00:00.000Z"
      }
    }
  ]
}

Champs de la réponse

  • (segment)

    Le segment tel qu'enregistré.

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…

  • CMDINTERNAL

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