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.

POSThttps://g.sendcorex.com/v1/privacy
i

Envelope-nya sama dengan Logs, Contacts, dan Bounces & Complaints. Halaman-halaman di bawah ini mendokumentasikan setiap perintah.

i

Error dilaporkan per perintah. Perintah yang gagal tidak menghentikan perintah lain, dan status HTTP tetap 200.

Parameter body

  • commandsobject[]wajib

    1 hingga 20 perintah, dijalankan berurutan. Seluruh body bisa berukuran hingga 1 MB.

  • commands[].commandstringwajib

    get_preferences, get_many, get_history, list_changes, atau set_preferences.

  • commands[].argsobjectopsional

    Argumen perintah.

  • commands[].idstringopsional

    Pengenal 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

  • type

    Selalu SUCCESS jika request itu sendiri diterima.

  • results[].command

    Perintah yang menghasilkan hasil ini.

  • results[].id

    id yang Anda kirim, atau indeks perintah.

  • results[].type

    SUCCESS atau ERROR.

  • results[].took_ms

    Waktu yang dibutuhkan perintah di dalam server.

  • results[].data

    Output perintah. Hanya ada jika type bernilai SUCCESS.

  • results[].code / message

    Error-nya. Hanya ada jika type bernilai ERROR.

Autentikasi

Gunakan API key yang Anda buat di dashboard, di Developers → API Keys.

  • Authorization

    Kirim Authorization: <api key> atau Authorization: Bearer <api key>.

  • privacy:read

    Get Preferences, Get Many, Get History, dan List Changes.

  • privacy:write

    Set Preferences.

  • Token mailbox

    Token webmail tidak berfungsi di sini. Token itu ditolak dengan WRONG_CREDENTIAL_TYPE.

  • IP yang diizinkan

    Jika 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 / detik

    Puncak 15. Respons yang disajikan dari cache juga dihitung.

  • 15 bersamaan

    Paling banyak 15 request diproses pada saat yang sama.

  • Cache baca: 1,5 dtk

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

  • 400INVALID_JSON

    Body bukan {"commands":[...]} atau lebih besar dari 1 MB.

  • 400INVALID_ARGS

    Request tidak memiliki perintah atau lebih dari 20.

  • 401MISSING_AUTH_HEADER

    Tidak ada header Authorization yang dikirim.

  • 401INVALID_API_KEY

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

  • 401API_KEY_EXPIRED

    API key telah melewati tanggal kedaluwarsa yang diatur di dashboard.

  • 401WRONG_CREDENTIAL_TYPE

    Yang dikirim adalah token mailbox. API ini membutuhkan API key dari dashboard.

  • 403IP_NOT_ALLOWED

    Request berasal dari IP yang tidak termasuk IP yang diizinkan untuk key ini.

  • 403ACCOUNT_BLOCKED

    Akun diblokir.

  • 403MISSING_SCOPE

    Key tidak memiliki `privacy:read` maupun `privacy:write`, jadi tidak ada perintah yang bisa dijalankan.

  • 429RATE_LIMITED

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

  • 503AUTH_UNAVAILABLE

    Autentikasi sementara tidak tersedia. Coba lagi.

  • CMDUNKNOWN_COMMAND

    Nama perintah tidak ada.

  • CMDINTERNAL

    Error server. Detailnya hanya ditulis ke log server.