Kontak: list
Perbarui list
Ubah nama, deskripsi, sumber, atau data custom sebuah list. Hanya yang Anda kirim yang berubah.
https://g.sendcorex.com/v1/contactscommand: update_listMembutuhkan scope contact:update pada API key Anda.
Argumen
list_idstringwajibList yang diubah. Id-nya sendiri tidak bisa diubah.
mis.
"customers"namestringopsionalNama baru.
nullmengosongkannya.descriptionstringopsionalDeskripsi baru.
nullmengosongkannya.sourcestringopsionalSumber baru.
nullmengosongkannya.customobjectopsionalDigabungkan ke data custom yang ada. Key yang dikirim sebagai
nulldihapus.mis.
{ "year": null, "owner": "sales" }
Mulai cepat
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/contacts',
{
commands: [
{
command: "update_list",
args: {
list_id: "customers",
name: "Customers (VIP)",
custom: {
year: null,
owner: "sales"
}
}
}
]
},
{ 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": "update_list",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"list_id": "customers",
"name": "Customers (VIP)",
"description": "Everyone who bought at least once",
"source": "checkout",
"status": "ready",
"custom": {
"origin": "checkout",
"owner": "sales"
},
"created_at": "2026-10-01T10:00:00.000Z",
"updated_at": "2026-10-12T15:22:41.000Z",
"stats": {
"total": 1834,
"ok": 1790,
"opened": 912,
"clicked": 233
}
}
}
]
}Field respons
(list)List setelah perubahan, beserta
stats.
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
INVALID_ARGSArgumen wajib tidak ada atau tidak valid: email, nilai field, opsi enum, key where, id list…
- CMD
NOT_FOUNDKontak, list, field, atau segmen tidak ada.
- CMD
INTERNALError server. Detailnya hanya ditulis ke log server.