Tracking Preferences: Menulis

Atur preferensi

Catat pilihan tracking penerima, misalnya persetujuan yang Anda kumpulkan di formulir atau CRM Anda sendiri.

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

Membutuhkan scope privacy:write pada API key Anda.

i

Kirim hanya yang berubah: field yang tidak Anda kirim mempertahankan nilainya saat ini. Mengirim nilai yang sama lagi tidak mengubah apa pun dan changed kembali sebagai false.

i

Perubahan yang dibuat di sini dicatat dengan source: "api" di riwayat. Perubahan ini tidak memicu webhook tracking_preferences_updated, jadi sinkronisasi CRM tidak pernah berputar-putar.

Argumen

  • emailstringwajib

    Alamat penerima.

    mis. "jane.doe@example.com"

  • track_opensbooleanopsional

    true mengizinkan pelacakan open, false menolaknya.

    mis. true

  • track_clicksbooleanopsional

    true mengizinkan pelacakan klik, false menolaknya.

    mis. true

Mulai cepat

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/privacy',
  {
    commands: [
      {
        command: "set_preferences",
        args: {
          email: "jane.doe@example.com",
          track_opens: true,
          track_clicks: true
        }
      }
    ]
  },
  { 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": "set_preferences",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 6,
      "data": {
        "changed": true,
        "preference": {
          "email": "jane.doe@example.com",
          "track_opens": true,
          "track_clicks": true,
          "source": "api",
          "updated_at": "2026-10-24T08:02:19.744Z"
        }
      }
    }
  ]
}

Field respons

  • changed

    false jika penerima sudah memiliki nilai-nilai ini (tidak ada yang ditulis).

  • preference

    Status setelah panggilan.

  • 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.