Recevoir des emails : Contacts et audience

Lister les segments

Liste les segments enregistrés de cette boîte, avec les champs personnalisés et les totaux. Lecture seule.

POSThttps://g.sendcorex.com/v1command: list_segments

Arguments

Cet endpoint n'accepte aucun argument.

Démarrage rapide

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "list_segments"
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_TOKEN } },
);

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": "list_segments",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "segments": [
          {
            "segment_id": "seg_8Hq2",
            "name": "Opened in 30 days",
            "where": {
              "last_open_at": {
                "within_days": 30
              }
            },
            "sort": null,
            "created_at": "2026-11-21T10:00:00Z",
            "updated_at": "2026-11-21T10:00:00Z"
          }
        ],
        "fields": [
          {
            "key": "plan",
            "name": "Plan",
            "type": "enum",
            "options": [
              "free",
              "pro"
            ]
          }
        ],
        "stats": {
          "total": 1240
        }
      }
    }
  ]
}

Champs de la réponse

  • segments[]

    segment_id, name, where, sort, created_at et updated_at.

  • fields

    Champs personnalisés du compte. Ils se créent dans le dashboard.

  • stats

    Totaux de contacts de cette boîte.

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.

  • 401TOKEN_EXPIRED

    L'access token a expiré. Appelez Refresh Token et relancez la requête.

  • 401INVALID_TOKEN

    Le token est mal formé, inconnu ou révoqué.

  • 429RATE_LIMITED

    Plus de 15 requêtes/s ou 15 en cours pour la même IP + boîte aux lettres. Attendez le nombre de secondes indiqué dans Retry-After.

  • CMDINTERNAL

    Erreur serveur. Le détail est uniquement écrit dans le log du serveur.