Kontak: tag, status, dan field

Tambah tag

Tambahkan satu atau beberapa tag ke hingga 500 kontak. Tag dibuat otomatis dan mengabaikan huruf besar/kecil serta aksen.

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

Membutuhkan scope contact:update pada API key Anda.

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.

  • tagsstring[]wajib

    Tag yang ditambahkan. "Black Friday" dan "black friday" adalah tag yang sama.

    mis. ["black-friday"]

  • 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: "add_tags",
        args: {
          emails: [
            "ana@acme.com",
            "bob@gmail.com"
          ],
          tags: [
            "black-friday"
          ]
        }
      }
    ]
  },
  { 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": "add_tags",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "items": [
          {
            "id": "ana@acme.com",
            "ok": true,
            "data": {
              "changed": true
            }
          },
          {
            "id": "bob@gmail.com",
            "ok": true,
            "data": {
              "changed": true
            }
          }
        ],
        "ok_count": 2,
        "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.

Beri tag ke semua hasil query

Gabungkan dengan Query Contacts dan $ref untuk memberi tag ke seluruh segmen dalam satu request, tanpa memindahkan email melalui aplikasi Anda.

Body request

{
  "commands": [
    {
      "command": "query_contacts",
      "id": "q",
      "args": {
        "where": {
          "last_open_at": {
            "within_days": 7
          }
        },
        "select": [
          "email"
        ],
        "limit": 500
      }
    },
    {
      "command": "add_tags",
      "args": {
        "emails": {
          "$ref": "q",
          "path": "contacts/*/email"
        },
        "tags": [
          "active-this-week"
        ]
      }
    }
  ]
}
i

Satu kontak bisa memiliki hingga 50 tag. Jumlah tag per akun ada di Get Stats.

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.