Tracking Preferences: Rute
Run Commands
Satu-satunya titik masuk untuk preferensi tracking. Kirim 1 hingga 20 perintah dalam satu request dan dapatkan satu hasil per perintah.
https://g.sendcorex.com/v1/privacyEnvelope-nya sama dengan Logs, Contacts, dan Bounces & Complaints. Halaman-halaman di bawah ini mendokumentasikan setiap perintah.
Error dilaporkan per perintah. Perintah yang gagal tidak menghentikan perintah lain, dan status HTTP tetap 200.
Parameter body
commandsobject[]wajib1 hingga 20 perintah, dijalankan berurutan. Seluruh body bisa berukuran hingga 1 MB.
commands[].commandstringwajibget_preferences,get_many,get_history,list_changes, atauset_preferences.commands[].argsobjectopsionalArgumen perintah.
commands[].idstringopsionalPengenal Anda sendiri untuk hasilnya. Default-nya indeks (
"0","1"…).
Mulai cepat
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/privacy',
{
commands: [
{
command: "set_preferences",
id: "set",
args: {
email: "jane.doe@example.com",
track_opens: false
}
},
{
command: "get_preferences",
id: "get",
args: {
email: "jane.doe@example.com"
}
}
]
},
{ headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);
for (const result of response.data.results) {
if (result.type !== 'SUCCESS') console.error(result.id, result.code, result.message);
else console.log(result.id, result.data);
}Respons
{
"type": "SUCCESS",
"results": [
{
"command": "set_preferences",
"id": "set",
"type": "SUCCESS",
"took_ms": 9,
"data": {
"changed": true,
"preference": {
"email": "jane.doe@example.com",
"track_opens": false,
"track_clicks": true,
"source": "api",
"updated_at": "2026-10-24T07:20:12.031Z"
}
}
},
{
"command": "get_preferences",
"id": "get",
"type": "SUCCESS",
"took_ms": 3,
"data": {
"preference": {
"email": "jane.doe@example.com",
"track_opens": false,
"track_clicks": true,
"source": "api",
"updated_at": "2026-10-24T07:20:12.031Z"
}
}
}
]
}Field respons
typeSelalu
SUCCESSjika request itu sendiri diterima.results[].commandPerintah yang menghasilkan hasil ini.
results[].ididyang Anda kirim, atau indeks perintah.results[].typeSUCCESSatauERROR.results[].took_msWaktu yang dibutuhkan perintah di dalam server.
results[].dataOutput perintah. Hanya ada jika
typebernilaiSUCCESS.results[].code / messageError-nya. Hanya ada jika
typebernilaiERROR.
Autentikasi
Gunakan API key yang Anda buat di dashboard, di Developers → API Keys.
AuthorizationKirim
Authorization: <api key>atauAuthorization: Bearer <api key>.privacy:readGet Preferences, Get Many, Get History, dan List Changes.
privacy:writeSet Preferences.
Token mailboxToken webmail tidak berfungsi di sini. Token itu ditolak dengan
WRONG_CREDENTIAL_TYPE.IP yang diizinkanJika key memiliki allowlist IP, request dari IP lain mendapat
403 IP_NOT_ALLOWED.
Rate limit dan cache
Batas berlaku per IP + API key. Jika Anda melewatinya, request ditolak dengan HTTP 429 dan header Retry-After.
15 request / detikPuncak 15. Respons yang disajikan dari cache juga dihitung.
15 bersamaanPaling banyak 15 request diproses pada saat yang sama.
Cache baca: 1,5 dtkPembacaan yang sama dalam 1,5 detik mengembalikan hasil yang sama. Set Preferences tidak pernah di-cache.
Error
Error di level HTTP mengembalikan type, code, dan message. Error yang ditandai CMD dikembalikan di dalam hasil perintah, dengan HTTP 200.
- 400
INVALID_JSONBody bukan {"commands":[...]} atau lebih besar dari 1 MB.
- 400
INVALID_ARGSRequest tidak memiliki perintah atau lebih dari 20.
- 401
MISSING_AUTH_HEADERTidak ada header Authorization yang dikirim.
- 401
INVALID_API_KEYAPI key tidak ada, telah dicabut, atau dinonaktifkan di dashboard.
- 401
API_KEY_EXPIREDAPI key telah melewati tanggal kedaluwarsa yang diatur di dashboard.
- 401
WRONG_CREDENTIAL_TYPEYang dikirim adalah token mailbox. API ini membutuhkan API key dari dashboard.
- 403
IP_NOT_ALLOWEDRequest berasal dari IP yang tidak termasuk IP yang diizinkan untuk key ini.
- 403
ACCOUNT_BLOCKEDAkun diblokir.
- 403
MISSING_SCOPEKey tidak memiliki `privacy:read` maupun `privacy:write`, jadi tidak ada perintah yang bisa dijalankan.
- 429
RATE_LIMITEDLebih dari 15 request/dtk atau 15 bersamaan untuk IP + API key yang sama. Tunggu sejumlah detik yang ada di Retry-After.
- 503
AUTH_UNAVAILABLEAutentikasi sementara tidak tersedia. Coba lagi.
- CMD
UNKNOWN_COMMANDNama perintah tidak ada.
- CMD
INTERNALError server. Detailnya hanya ditulis ke log server.