Kontak: segmen

Daftar segmen

Semua segmen tersimpan di akun, beserta where dan sort-nya.

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

Membutuhkan scope contact:read pada API key Anda.

Argumen

Endpoint ini tidak menerima argumen.

Mulai cepat

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);

Respons

{
  "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"
          }
        ]
      }
    }
  ]
}

Field respons

  • segments[].segment_id

    Id yang digunakan oleh Run Segment.

  • segments[].name

    Nama tampilan.

  • segments[].where / sort

    Query yang disimpan, dengan format yang sama seperti Query Contacts.

Error

Error di level HTTP mengembalikan type, code, dan message. Error yang ditandai CMD dikembalikan di dalam hasil perintah, dengan HTTP 200.

  • 401INVALID_API_KEY

    API key tidak ada, sudah dicabut, atau dinonaktifkan di dashboard.

  • 429RATE_LIMITED

    Lebih dari 15 request/detik atau 15 bersamaan untuk IP + API key yang sama. Tunggu sesuai jumlah detik di Retry-After.

  • CMDMISSING_SCOPE

    API key tidak memiliki scope yang dibutuhkan perintah ini. Perintah lain dalam request tetap berjalan.

  • CMDINTERNAL

    Error server. Detailnya hanya ditulis ke log server.