Kontak: list

Hapus dari list

Keluarkan hingga 500 kontak dari satu atau beberapa list. Mereka tidak lagi menjadi anggota; hal lain tidak berubah.

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

Membutuhkan scope contact:update pada API key Anda.

i

Jika seseorang berhenti berlangganan dari list, sebaiknya gunakan Set List Subscription dengan subscribed: false: mereka tetap di list sebagai tidak berlangganan, sehingga Anda punya catatan bahwa mereka memilih keluar.

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_idsstring[]wajib

    List yang ditinggalkan.

    mis. ["leads"]

  • list_idstringopsional

    Satu list. Gunakan ini atau list_ids.

  • 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: "remove_from_lists",
        args: {
          emails: [
            "ana@acme.com"
          ],
          list_ids: [
            "leads"
          ]
        }
      }
    ]
  },
  { 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": "remove_from_lists",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "items": [
          {
            "id": "ana@acme.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 jika kontak tidak ada di list mana pun dari ini.

  • items[].data.contact

    Kontak lengkap setelah perubahan. Hanya dengan return_contacts: true.

  • ok_count / failed_count

    Berapa email yang berhasil dan berapa yang gagal.

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.