Sender: route

Run Commands

Satu-satunya titik masuk untuk sender. Kirim 1 sampai 20 perintah dalam satu request dan dapatkan satu hasil per perintah.

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

Envelope yang sama dengan Domains, Contacts, dan Logs. Halaman di bawah ini mendokumentasikan setiap perintah.

i

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

Parameter body

  • commandsobject[]wajib

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

  • commands[].commandstringwajib

    list_senders, get_sender, create_sender, update_sender, update_sender_description, atau delete_sender.

  • commands[].argsobjectopsional

    Argumen perintah. Nilai apa pun bisa berupa $ref ke hasil perintah sebelumnya.

  • commands[].idstringopsional

    Identifier Anda sendiri untuk hasilnya. Default-nya indeks ("0", "1"…). Wajib jika Anda ingin memakai $ref.

Mulai cepat

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/sender',
  {
    commands: [
      {
        command: "list_senders",
        id: "all"
      },
      {
        command: "get_sender",
        id: "one",
        args: {
          sender_id: "K7Q2M9XR4TB8WD1ZC6NF3HJP"
        }
      }
    ]
  },
  { 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": "list_senders",
      "id": "all",
      "type": "SUCCESS",
      "took_ms": 5,
      "data": {
        "senders": [
          {
            "sender_id": "K7Q2M9XR4TB8WD1ZC6NF3HJP",
            "email": "hello@acme.com",
            "username": "hello",
            "domain": "acme.com",
            "from_name": "Acme",
            "reply_to": "support@acme.com",
            "description": "Product updates",
            "avatar_color": "#2F6FDB",
            "warmup_enabled": false,
            "reputation": {
              "delivered": 18420,
              "bounced": 131,
              "spam": 6,
              "received_messages": 2210,
              "total_emails": 18557,
              "has_minimum_volume": true,
              "delivery_rate": 99,
              "bounce_rate": 1,
              "spam_rate": 0,
              "engagement_rate": 12,
              "score": 100,
              "status": "Excellent"
            },
            "created_at": "2026-09-02T14:40:12.530Z",
            "updated_at": "2026-10-20T08:15:33.004Z"
          }
        ]
      }
    },
    {
      "command": "get_sender",
      "id": "one",
      "type": "SUCCESS",
      "took_ms": 2,
      "data": {
        "sender_id": "K7Q2M9XR4TB8WD1ZC6NF3HJP",
        "email": "hello@acme.com",
        "username": "hello",
        "domain": "acme.com",
        "from_name": "Acme",
        "reply_to": "support@acme.com",
        "description": "Product updates",
        "avatar_color": "#2F6FDB",
        "warmup_enabled": false,
        "reputation": {
          "delivered": 18420,
          "bounced": 131,
          "spam": 6,
          "received_messages": 2210,
          "total_emails": 18557,
          "has_minimum_volume": true,
          "delivery_rate": 99,
          "bounce_rate": 1,
          "spam_rate": 0,
          "engagement_rate": 12,
          "score": 100,
          "status": "Excellent"
        },
        "created_at": "2026-09-02T14:40:12.530Z",
        "updated_at": "2026-10-20T08:15:33.004Z"
      }
    }
  ]
}

Field respons

  • type

    Selalu SUCCESS jika request-nya 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, dengan scope yang dibutuhkan perintah.

  • Authorization

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

  • sender:read

    list_senders dan get_sender.

  • sender:create

    create_sender.

  • sender:update

    update_sender dan update_sender_description.

  • sender:delete

    delete_sender.

  • Token mailbox

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

  • IP yang diizinkan

    Jika key memiliki allowlist IP, request dari IP lain mendapat 403 IP_NOT_ALLOWED.

Merangkai dengan $ref

Buat sender dan kirim id-nya ke perintah berikutnya dalam request yang sama.

create_sender → update_sender_description

{
  "commands": [
    {
      "command": "create_sender",
      "id": "new",
      "args": {
        "username": "news",
        "from_name": "Acme News",
        "reply_to": "news@acme.com",
        "domain": "acme.com"
      }
    },
    {
      "command": "update_sender_description",
      "args": {
        "sender_id": {
          "$ref": "new",
          "path": "sender_id"
        },
        "description": "Monthly newsletter"
      }
    }
  ]
}

Rate limit

  • 15 request / detik

    Per IP + API key. Jika melebihi, HTTP 429 dengan header Retry-After.

  • 15 bersamaan

    Maksimal 15 request diproses pada saat yang sama, per IP + API key.

  • Per perintah, per akun

    create_sender dan update_sender 10/menit · update_sender_description 20/menit · delete_sender 30/menit. Jika melebihi, perintah tersebut menjawab RATE_LIMITED.

  • Tanpa cache

    Setiap panggilan membaca database. Yang Anda dapatkan selalu terbaru.

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, sudah dicabut, atau dinonaktifkan di dashboard.

  • 401API_KEY_EXPIRED

    API key telah melewati tanggal kedaluwarsa yang diatur di dashboard.

  • 401WRONG_CREDENTIAL_TYPE

    Token mailbox yang dikirim. Senders API membutuhkan API key dari dashboard.

  • 403IP_NOT_ALLOWED

    Request berasal dari IP yang tidak ada dalam daftar IP yang diizinkan untuk key ini.

  • 403ACCOUNT_BLOCKED

    Akun diblokir.

  • 403MISSING_SCOPE

    Key tidak memiliki scope `sender:*`, jadi tidak ada perintah yang bisa dijalankan.

  • 429RATE_LIMITED

    Lebih dari 15 request/detik atau 15 bersamaan untuk IP + API key yang sama. Tunggu sesuai jumlah detik 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.