Kontak: list
Hapus dari list
Keluarkan hingga 500 kontak dari satu atau beberapa list. Mereka tidak lagi menjadi anggota; hal lain tidak berubah.
https://g.sendcorex.com/v1/contactscommand: remove_from_listsMembutuhkan scope contact:update pada API key Anda.
Jika seseorang berhenti berlangganan dari list, sebaiknya gunakan Set List Subscription dengan subscribed: false: mereka tetap di list sebagai tidak berlangganan, sehingga Anda punya catatan bahwa mereka memilih keluar.
Argumen
emailsstring[]opsionalHingga 500 email. Huruf besar/kecil dan spasi di sekitarnya diabaikan, dan email yang berulang dihitung sekali.
emailstringopsionalSatu email. Gunakan ini atau
emails.list_idsstring[]wajibList yang ditinggalkan.
mis.
["leads"]list_idstringopsionalSatu list. Gunakan ini atau
list_ids.return_contactsbooleanopsionalMenambahkan kontak lengkap setelah perubahan ke setiap item.
Mulai cepat
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/contacts',
{
commands: [
{
command: "remove_from_lists",
args: {
emails: [
"ana@acme.com"
],
list_ids: [
"leads"
]
}
}
]
},
{ 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": "remove_from_lists",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"items": [
{
"id": "ana@acme.com",
"ok": true,
"data": {
"changed": true
}
}
],
"ok_count": 1,
"failed_count": 0
}
}
]
}Field respons
items[].idEmail yang Anda kirim, sesuai yang Anda kirim.
items[].oktruejika email ini berhasil. Jikafalse, item memilikicodedanmessage.items[].data.changedfalsejika kontak tidak ada di list mana pun dari ini.items[].data.contactKontak lengkap setelah perubahan. Hanya dengan
return_contacts: true.ok_count / failed_countBerapa email yang berhasil dan berapa yang gagal.
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.