Kontak: list

Hapus list

Hapus list. List langsung hilang; anggotanya dikeluarkan di latar belakang. Kontaknya sendiri tetap disimpan.

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

Membutuhkan scope contact:delete pada API key Anda.

i

Hanya keanggotaan yang dihapus. Kontak, tag, field, dan list lainnya tetap ada. Untuk menghapus orangnya juga, query mereka dulu lalu gunakan Delete Contacts.

Argumen

  • list_idstringwajib

    List yang dihapus.

    mis. "old-leads"

Mulai cepat

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "delete_list",
        args: {
          list_id: "old-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": "delete_list",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "deleted": true,
        "purging": true
      }
    }
  ]
}

Field respons

  • deleted

    true. List tidak lagi muncul di List Lists atau Get List.

  • purging

    true selama anggota sedang dikeluarkan dari list di latar belakang.

Yang terjadi di latar belakang

List besar dibersihkan secara bertahap. Sampai selesai, list_lists dengan include_deleting: true masih menampilkan list dengan status: "deleting".

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.