Kontak: list

Atur langganan list

Berhentikan langganan hingga 500 kontak dari satu list, atau langgankan kembali, tanpa mengubah list lain maupun status globalnya.

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

Membutuhkan scope contact:update pada API key Anda.

i

Kontak yang bukan anggota list dibiarkan apa adanya dan kembali dengan changed: false. Gunakan Add To Lists untuk menjadikan mereka anggota terlebih dahulu.

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.

  • list_idstringwajib

    List-nya.

    mis. "newsletter"

  • subscribedbooleanwajib

    false untuk berhenti berlangganan list ini, true untuk berlangganan lagi.

  • 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_list_subscription",
        args: {
          emails: [
            "bob@gmail.com"
          ],
          list_id: "newsletter",
          subscribed: false
        }
      }
    ]
  },
  { 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_list_subscription",
      "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.

Langganan list atau status global?

  • Set List Subscription

    Orang tersebut masih ingin menerima list Anda yang lain. Mereka tetap menjadi anggota di sini, ditandai tidak berlangganan, dan tidak lagi dapat dikirimi hanya di list ini.

  • Set Status

    Orang tersebut tidak ingin menerima email sama sekali, atau alamatnya bounce. Sendable menjadi false di semua list.

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.