Tracking Preferences: Membaca

Ambil preferensi

Pilihan pelacakan open dan klik dari satu penerima. Satu pencarian per alamat, tanpa pemindaian.

POSThttps://g.sendcorex.com/v1/privacycommand: get_preferences
i

Membutuhkan scope privacy:read pada API key Anda.

i

preference bernilai null jika penerima belum pernah membuka halaman preferensi tracking dan Anda belum pernah mengatur apa pun untuknya.

Argumen

  • emailstringwajib

    Alamat 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

  • preference

    Preferensi di bawah, atau null jika tidak ada.

  • preference.email

    Alamat penerima, dalam huruf kecil.

  • preference.track_opens

    true penerima mengizinkan pelacakan open, false menolaknya, null belum pernah memilih.

  • preference.track_clicks

    true penerima mengizinkan pelacakan klik, false menolaknya, null belum pernah memilih.

  • preference.source

    Siapa yang melakukan perubahan: page (penerima, di halaman preferensi tracking), api (Anda, dengan Set Preferences), atau dashboard.

  • preference.updated_at

    Kapan perubahan dilakukan. ISO 8601, UTC.

Pengaruhnya pada pengiriman Anda

  • Penolakan selalu menang

    Jika track_opens atau track_clicks bernilai false, tracking tersebut tidak disertakan di email meskipun pengiriman Anda memintanya dengan "track_opens": true.

  • Belum pernah memilih

    Jika nilainya null (atau penerima tidak punya preferensi sama sekali), pengiriman Anda yang menentukan, persis seperti sebelumnya.

  • Membutuhkan mesin unsubscribe kami

    Preferensi diterapkan pada pengiriman dengan "unsubscribe": true. Itu juga yang menaruh link preferensi di email.

  • Default Anda

    Untuk aturan opt-in (misalnya Prancis), kirim "track_opens": false dan "track_clicks": false sampai 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.

  • 401INVALID_API_KEY

    API key tidak ada, telah dicabut, atau dinonaktifkan di dashboard.

  • 429RATE_LIMITED

    Lebih dari 15 request/dtk atau 15 bersamaan untuk IP + API key yang sama. Tunggu sejumlah detik yang ada di Retry-After.

  • CMDMISSING_SCOPE

    API key tidak memiliki scope perintah ini (`privacy:read` untuk membaca, `privacy:write` untuk mengubah).

  • CMDINVALID_ARGS

    Ada argumen yang tidak valid: `email` tidak ada atau salah format, lebih dari 100 `emails`, `track_opens` yang bukan `true`/`false`, limit di luar rentang…

  • CMDINTERNAL

    Error server. Detailnya hanya ditulis ke log server.