Kontak: list
Atur langganan list
Berhentikan langganan hingga 500 kontak dari satu list, atau langgankan kembali, tanpa mengubah list lain maupun status globalnya.
https://g.sendcorex.com/v1/contactscommand: set_list_subscriptionMembutuhkan scope contact:update pada API key Anda.
Kontak yang bukan anggota list dibiarkan apa adanya dan kembali dengan changed: false. Gunakan Add To Lists untuk menjadikan mereka anggota terlebih dahulu.
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_idstringwajibList-nya.
mis.
"newsletter"subscribedbooleanwajibfalseuntuk berhenti berlangganan list ini,trueuntuk berlangganan lagi.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: "set_list_subscription",
args: {
emails: [
"bob@gmail.com"
],
list_id: "newsletter",
subscribed: false
}
}
]
},
{ 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": "set_list_subscription",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"items": [
{
"id": "bob@gmail.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.changedfalseberarti kontak sudah seperti ini, jadi tidak ada yang ditulis.items[].data.contactKontak lengkap setelah perubahan. Hanya dengan
return_contacts: true.ok_count / failed_countBerapa email yang berhasil dan berapa yang gagal.
Langganan list atau status global?
Set List SubscriptionOrang tersebut masih ingin menerima list Anda yang lain. Mereka tetap menjadi anggota di sini, ditandai tidak berlangganan, dan tidak lagi dapat dikirimi hanya di list ini.
Set StatusOrang tersebut tidak ingin menerima email sama sekali, atau alamatnya bounce. Sendable menjadi
falsedi semua list.
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.