Kontak: list

Buat list

Buat list. Pilih id sendiri agar kode Anda bisa merujuknya, atau biarkan server membuatkannya.

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

Membutuhkan scope contact:create pada API key Anda.

i

List mengelompokkan kontak untuk pengiriman. Kontaknya sendiri milik akun: menambahkannya ke list tidak menyalinnya.

Argumen

  • list_idstringopsional

    Id Anda sendiri: a-z, 0-9, _, dan -, hingga 40 karakter. Dibuat otomatis jika dikosongkan. Id yang sudah ada gagal dengan ALREADY_EXISTS.

    mis. "customers"

  • namestringopsional

    Nama tampilan.

    mis. "Customers"

  • descriptionstringopsional

    Teks bebas yang ditampilkan bersama list.

  • sourcestringopsional

    Asal kontak, sebagai referensi Anda.

    mis. "checkout"

  • customobjectopsional

    Data Anda sendiri, hingga 50 key.

    mis. { "origin": "checkout", "year": 2026 }

Mulai cepat

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "create_list",
        args: {
          list_id: "customers",
          name: "Customers",
          description: "Everyone who bought at least once",
          source: "checkout",
          custom: {
            origin: "checkout",
            year: 2026
          }
        }
      }
    ]
  },
  { 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": "create_list",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "list_id": "customers",
        "name": "Customers",
        "description": "Everyone who bought at least once",
        "source": "checkout",
        "status": "ready",
        "custom": {
          "origin": "checkout",
          "year": 2026
        },
        "created_at": "2026-10-01T10:00:00.000Z",
        "updated_at": "2026-10-12T15:22:41.000Z",
        "stats": {
          "total": 0,
          "ok": 0,
          "opened": 0,
          "clicked": 0
        }
      }
    }
  ]
}

Field respons

  • list_id

    Id yang Anda kirim atau yang dibuat otomatis.

  • status

    ready.

  • stats

    Penghitung, semuanya 0 untuk list baru.

Berikutnya: isi list

Kirim list_id dengan Upsert Contacts untuk mengimpor langsung ke list, atau gunakan Add To Lists untuk kontak yang sudah Anda miliki.

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…

  • CMDALREADY_EXISTS

    create_list dipanggil dengan list_id yang sudah ada.

  • CMDINTERNAL

    Error server. Detailnya hanya ditulis ke log server.