Kontak: kontak
Perbarui kontak
Ubah kontak yang sudah ada, hingga 500 per perintah. Argumennya sama dengan Upsert Contacts, tetapi tidak pernah membuat: email yang bukan kontak gagal dengan NOT_FOUND.
https://g.sendcorex.com/v1/contactscommand: update_contactsMembutuhkan scope contact:update pada API key Anda.
Gunakan jika aplikasi Anda hanya boleh mengubah orang yang sudah menjadi kontak, misalnya formulir profil yang tidak boleh menambahkan orang asing.
Argumen
contactsobject[]wajib1 sampai 500 baris dengan
emaildan bagian yang ingin diubah. Field-nya sama dengan Upsert Contacts.list_idstringopsionalJuga menambahkan semua kontak dalam perintah ini ke list ini.
tagsstring[]opsionalTag yang ditambahkan ke semua kontak dalam perintah ini.
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: "update_contacts",
args: {
contacts: [
{
email: "ana@acme.com",
last_name: "Costa",
fields: {
plan: "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": "update_contacts",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"items": [
{
"id": "ana@acme.com",
"ok": true,
"data": {
"created": false,
"changed": true
}
}
],
"ok_count": 1,
"failed_count": 0,
"created": 0,
"updated": 1,
"unchanged": 0
}
}
]
}Field respons
items[].data.changedfalsejika kontak sudah memiliki nilai-nilai ini.updated / unchangedBerapa kontak yang berubah dan berapa yang sudah terbaru.
createdselalu0.ok_count / failed_countBerapa baris 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.