Kontak: custom field
Hapus field
Hapus custom field. Field langsung hilang, dan nilainya dihapus dari semua kontak di latar belakang.
https://g.sendcorex.com/v1/contactscommand: delete_fieldMembutuhkan scope contact:delete pada API key Anda.
Nilainya tidak dapat dipulihkan. Segmen dan query yang memakai field ini langsung gagal dengan INVALID_ARGS.
Argumen
keystringwajibField yang dihapus.
mis.
"vip"
Mulai cepat
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/contacts',
{
commands: [
{
command: "delete_field",
args: {
key: "vip"
}
}
]
},
{ 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": "delete_field",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"deleted": true,
"purging": true
}
}
]
}Field respons
deletedtrue. Field tidak lagi muncul di List Fields.purgingtrueselama nilai sedang dihapus dari kontak.
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.