Kontak: custom field
Daftar field
Semua custom field di akun, beserta tipe dan opsinya, diurutkan berdasarkan key.
https://g.sendcorex.com/v1/contactscommand: list_fieldsMembutuhkan 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_fields"
}
]
},
{ 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_fields",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"fields": [
{
"key": "age",
"name": "Age",
"type": "number",
"options": null,
"created_at": "2026-10-01T10:00:00.000Z",
"updated_at": "2026-10-01T10:00:00.000Z"
},
{
"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"
}
],
"limit": 100
}
}
]
}Field respons
fields[].keyKey yang digunakan di
fields, diwhere, dan disort(fields.<key>).fields[].nameNama tampilan.
fields[].typetext,number,date,bool,enum, ataumulti_enum.fields[].optionsNilai yang diizinkan untuk field
enumdanmulti_enum.limitJumlah field yang dapat dimiliki akun (100).
Error
Error di level HTTP mengembalikan type, code, dan message. Error yang ditandai CMD dikembalikan di dalam hasil perintah, dengan HTTP 200.
- 401
INVALID_API_KEYAPI key tidak ada, sudah dicabut, atau dinonaktifkan di dashboard.
- 429
RATE_LIMITEDLebih dari 15 request/detik atau 15 bersamaan untuk IP + API key yang sama. Tunggu sesuai jumlah detik di Retry-After.
- CMD
MISSING_SCOPEAPI key tidak memiliki scope yang dibutuhkan perintah ini. Perintah lain dalam request tetap berjalan.
- CMD
INTERNALError server. Detailnya hanya ditulis ke log server.