Tracking Preferences: Membaca
Ambil preferensi
Pilihan pelacakan open dan klik dari satu penerima. Satu pencarian per alamat, tanpa pemindaian.
https://g.sendcorex.com/v1/privacycommand: get_preferencesMembutuhkan scope privacy:read pada API key Anda.
preference bernilai null jika penerima belum pernah membuka halaman preferensi tracking dan Anda belum pernah mengatur apa pun untuknya.
Argumen
emailstringwajibAlamat penerima. Huruf besar/kecil tidak berpengaruh.
mis.
"jane.doe@example.com"
Mulai cepat
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/privacy',
{
commands: [
{
command: "get_preferences",
args: {
email: "jane.doe@example.com"
}
}
]
},
{ 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": "get_preferences",
"id": "0",
"type": "SUCCESS",
"took_ms": 6,
"data": {
"preference": {
"email": "jane.doe@example.com",
"track_opens": false,
"track_clicks": true,
"source": "page",
"updated_at": "2026-10-24T07:20:12.031Z"
}
}
}
]
}Field respons
preferencePreferensi di bawah, atau
nulljika tidak ada.preference.emailAlamat penerima, dalam huruf kecil.
preference.track_openstruepenerima mengizinkan pelacakan open,falsemenolaknya,nullbelum pernah memilih.preference.track_clickstruepenerima mengizinkan pelacakan klik,falsemenolaknya,nullbelum pernah memilih.preference.sourceSiapa yang melakukan perubahan:
page(penerima, di halaman preferensi tracking),api(Anda, dengan Set Preferences), ataudashboard.preference.updated_atKapan perubahan dilakukan. ISO 8601, UTC.
Pengaruhnya pada pengiriman Anda
Penolakan selalu menangJika
track_opensatautrack_clicksbernilaifalse, tracking tersebut tidak disertakan di email meskipun pengiriman Anda memintanya dengan"track_opens": true.Belum pernah memilihJika nilainya
null(atau penerima tidak punya preferensi sama sekali), pengiriman Anda yang menentukan, persis seperti sebelumnya.Membutuhkan mesin unsubscribe kamiPreferensi diterapkan pada pengiriman dengan
"unsubscribe": true. Itu juga yang menaruh link preferensi di email.Default AndaUntuk aturan opt-in (misalnya Prancis), kirim
"track_opens": falsedan"track_clicks": falsesampai penerima mengizinkannya, dan baca preferensinya dengan Get Many sebelum mengirim.
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, telah dicabut, atau dinonaktifkan di dashboard.
- 429
RATE_LIMITEDLebih dari 15 request/dtk atau 15 bersamaan untuk IP + API key yang sama. Tunggu sejumlah detik yang ada di Retry-After.
- CMD
MISSING_SCOPEAPI key tidak memiliki scope perintah ini (`privacy:read` untuk membaca, `privacy:write` untuk mengubah).
- CMD
INVALID_ARGSAda argumen yang tidak valid: `email` tidak ada atau salah format, lebih dari 100 `emails`, `track_opens` yang bukan `true`/`false`, limit di luar rentang…
- CMD
INTERNALError server. Detailnya hanya ditulis ke log server.