Contacts : segments

Lister les segments

Tous les segments enregistrés du compte, avec leur where et leur sort.

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

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

Arguments

Cet endpoint n'accepte aucun argument.

Démarrage rapide

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "list_segments"
      }
    ]
  },
  { 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": "list_segments",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "segments": [
          {
            "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

  • segments[].segment_id

    L'id utilisé par Run Segment.

  • segments[].name

    Nom affiché.

  • segments[].where / sort

    La requête enregistrée, au même format que Query Contacts.

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.

  • CMDINTERNAL

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