Kontak: segmen

Simpan segmen

Simpan query dengan sebuah nama, agar aplikasi Anda dan dashboard bisa menjalankannya nanti. Kontak tidak disalin: segmen dievaluasi ulang setiap kali dijalankan.

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

Membutuhkan scope contact:create pada API key Anda.

i

where divalidasi saat disimpan: key atau field yang tidak dikenal langsung gagal dengan INVALID_ARGS, bukan saat dijalankan berikutnya.

Argumen

  • segment_idstringopsional

    Id Anda sendiri. Dibuat otomatis jika dikosongkan. Menyimpan dengan id yang sudah ada akan mengganti segmen tersebut.

    mis. "engaged-vips"

  • namestringopsional

    Nama tampilan.

    mis. "Engaged VIPs"

  • whereobjectwajib

    where yang sama dengan Query Contacts.

  • sortstring | objectopsional

    sort yang sama dengan Query Contacts.

    mis. "open_rate"

Mulai cepat

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

Respons

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

Field respons

  • (segment)

    Segmen sebagaimana tersimpan.

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.

  • CMDINVALID_ARGS

    Argumen wajib tidak ada atau tidak valid: email, nilai field, opsi enum, key where, id list…

  • CMDINTERNAL

    Error server. Detailnya hanya ditulis ke log server.