Kontak: kontak

Perbarui kontak

Ubah kontak yang sudah ada, hingga 500 per perintah. Argumennya sama dengan Upsert Contacts, tetapi tidak pernah membuat: email yang bukan kontak gagal dengan NOT_FOUND.

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

Membutuhkan scope contact:update pada API key Anda.

i

Gunakan jika aplikasi Anda hanya boleh mengubah orang yang sudah menjadi kontak, misalnya formulir profil yang tidak boleh menambahkan orang asing.

Argumen

  • contactsobject[]wajib

    1 sampai 500 baris dengan email dan bagian yang ingin diubah. Field-nya sama dengan Upsert Contacts.

  • list_idstringopsional

    Juga menambahkan semua kontak dalam perintah ini ke list ini.

  • tagsstring[]opsional

    Tag yang ditambahkan ke semua kontak dalam perintah ini.

  • 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: "update_contacts",
        args: {
          contacts: [
            {
              email: "ana@acme.com",
              last_name: "Costa",
              fields: {
                plan: "business"
              }
            }
          ]
        }
      }
    ]
  },
  { 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": "update_contacts",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "items": [
          {
            "id": "ana@acme.com",
            "ok": true,
            "data": {
              "created": false,
              "changed": true
            }
          }
        ],
        "ok_count": 1,
        "failed_count": 0,
        "created": 0,
        "updated": 1,
        "unchanged": 0
      }
    }
  ]
}

Field respons

  • items[].data.changed

    false jika kontak sudah memiliki nilai-nilai ini.

  • updated / unchanged

    Berapa kontak yang berubah dan berapa yang sudah terbaru. created selalu 0.

  • ok_count / failed_count

    Berapa baris 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.