Kontak: custom field

Definisikan field

Buat custom field, atau ganti nama dan ubah opsinya. Setiap field diindeks sendiri, jadi Anda bisa langsung memfilter dan mengurutkan berdasarkan field tersebut.

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

Membutuhkan scope contact:create pada API key Anda.

i

Memanggilnya lagi dengan key dan type yang sama akan memperbarui nama dan opsi. Tipe tidak pernah berubah: mencobanya gagal dengan TYPE_LOCKED. Untuk mengubahnya, hapus field lalu buat lagi.

Argumen

  • keystringwajib

    a-z, 0-9, dan _, diawali huruf, hingga 40 karakter.

    mis. "plan"

  • typestringwajib

    text, number, date, bool, enum, atau multi_enum.

    mis. "enum"

  • namestringopsional

    Nama tampilan. Default-nya key.

    mis. "Plan"

  • optionsstring[]opsional

    Wajib untuk enum dan multi_enum: nilai yang diizinkan.

    mis. ["free", "pro", "business"]

Mulai cepat

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "define_field",
        args: {
          key: "plan",
          name: "Plan",
          type: "enum",
          options: [
            "free",
            "pro",
            "business"
          ]
        }
      }
    ]
  },
  { 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": "define_field",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "key": "plan",
        "name": "Plan",
        "type": "enum",
        "options": [
          "free",
          "pro",
          "business"
        ],
        "created_at": "2026-10-01T10:00:00.000Z",
        "updated_at": "2026-10-01T10:00:00.000Z"
      }
    }
  ]
}

Field respons

  • (field)

    Field sebagaimana tersimpan: key, name, type, options, created_at, updated_at.

Tipe

  • text

    Hingga 2.000 karakter. Filter dengan sama dengan (mengabaikan huruf besar/kecil dan aksen), contains, atau exists.

  • number

    Bilangan bulat atau desimal, termasuk negatif. "1234,5" dibaca sebagai 1234.5. Mendukung rentang dan pengurutan.

  • date

    YYYY-MM-DD atau ISO. Mendukung rentang dan pengurutan.

  • bool

    true atau false. "yes", "sim", dan "1" dibaca sebagai true.

  • enum

    Salah satu dari options. "PRO" disimpan sebagai "pro". Nilai di luar opsi membuat item gagal.

  • multi_enum

    Sejumlah options, berupa list atau "tech, golf". Tidak dapat dipakai untuk mengurutkan.

Siapkan semua field sekaligus

Body request

{
  "commands": [
    {
      "command": "define_field",
      "args": {
        "key": "plan",
        "name": "Plan",
        "type": "enum",
        "options": [
          "free",
          "pro",
          "business"
        ]
      }
    },
    {
      "command": "define_field",
      "args": {
        "key": "age",
        "name": "Age",
        "type": "number"
      }
    },
    {
      "command": "define_field",
      "args": {
        "key": "city",
        "name": "City",
        "type": "text"
      }
    },
    {
      "command": "define_field",
      "args": {
        "key": "birthday",
        "name": "Birthday",
        "type": "date"
      }
    },
    {
      "command": "define_field",
      "args": {
        "key": "interests",
        "name": "Interests",
        "type": "multi_enum",
        "options": [
          "golf",
          "tech",
          "travel"
        ]
      }
    },
    {
      "command": "define_field",
      "args": {
        "key": "vip",
        "name": "VIP",
        "type": "bool"
      }
    }
  ]
}
i

Satu akun bisa memiliki hingga 100 field. Lebih dari itu, define_field gagal dengan LIMIT_REACHED.

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…

  • CMDTYPE_LOCKED

    define_field mencoba mengubah tipe field yang sudah ada. Hapus lalu buat lagi.

  • CMDLIMIT_REACHED

    Akun sudah memiliki 100 custom field.

  • CMDINTERNAL

    Error server. Detailnya hanya ditulis ke log server.