Kontak: tag, status, dan field

Atur status

Ubah status global hingga 500 kontak: berhentikan langganan, blokir, atau langgankan kembali di semua list sekaligus.

POSThttps://g.sendcorex.com/v1/contactscommand: set_status
i

Membutuhkan scope contact:update pada API key Anda.

i

Status bersifat global. Kontak yang tidak subscribed tidak dapat dikirimi di list mana pun, meskipun masih berlangganan di sana. Untuk keluar dari satu list saja, gunakan Set List Subscription.

Argumen

  • emailsstring[]opsional

    Hingga 500 email. Huruf besar/kecil dan spasi di sekitarnya diabaikan, dan email yang berulang dihitung sekali.

  • emailstringopsional

    Satu email. Gunakan ini atau emails.

  • statusstringwajib

    subscribed, unsubscribed, bounced, complained, atau blocked.

    mis. "unsubscribed"

  • reasonstringopsional

    Alasan status berubah. Disimpan sebagai status_reason.

    mis. "asked by email"

  • return_contactsbooleanopsional

    Menambahkan kontak lengkap setelah perubahan ke setiap item.

Mulai cepat

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "set_status",
        args: {
          emails: [
            "bob@gmail.com"
          ],
          status: "unsubscribed",
          reason: "asked by email"
        }
      }
    ]
  },
  { 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_status",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "items": [
          {
            "id": "bob@gmail.com",
            "ok": true,
            "data": {
              "changed": true
            }
          }
        ],
        "ok_count": 1,
        "failed_count": 0
      }
    }
  ]
}

Field respons

  • items[].id

    Email yang Anda kirim, sesuai yang Anda kirim.

  • items[].ok

    true jika email ini berhasil. Jika false, item memiliki code dan message.

  • items[].data.changed

    false berarti kontak sudah seperti ini, jadi tidak ada yang ditulis.

  • items[].data.contact

    Kontak lengkap setelah perubahan. Hanya dengan return_contacts: true.

  • ok_count / failed_count

    Berapa email yang berhasil dan berapa yang gagal.

Status

  • subscribed

    Dapat menerima email dari list yang dilanggani.

  • unsubscribed

    Meminta untuk berhenti menerima email.

  • bounced

    Alamat ini tidak menerima email.

  • complained

    Menandai salah satu email Anda sebagai spam.

  • blocked

    Diblokir oleh Anda. Gunakan untuk alamat yang tidak ingin Anda kirimi email.

!

Mengatur subscribed lagi untuk orang yang berhenti berlangganan atau mengeluh hanya boleh dilakukan jika mereka memintanya.

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

  • 429RATE_LIMITED

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

  • CMDMISSING_SCOPE

    API key tidak memiliki scope yang dibutuhkan perintah ini. Perintah lain dalam request tetap berjalan.

  • CMDINVALID_ARGS

    Argumen wajib tidak ada atau tidak valid: email, nilai field, opsi enum, key where, id list…

  • CMDNOT_FOUND

    Kontak, list, field, atau segmen tidak ada.

  • CMDINTERNAL

    Error server. Detailnya hanya ditulis ke log server.