Perbarui Kontak

Pengembang dapat memperbarui informasi kontak melalui API.

Metode Permintaan

PATCH

URL Permintaan

https://livedesk-api.engagelab.com/api/v2/accounts/contacts/:id

Autentikasi

Untuk detail lebih lanjut, lihat deskripsi metode autentikasi di Ikhtisar API.

Permintaan

Contoh Permintaan

curl -X PATCH https://livedesk-api.engagelab.com/api/v2/accounts/contacts/:id \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic base64(api_key:api_secret)' \ { "additional_attributes": { "description": "", "company_name": "", "city": "", "telegram": "", "country": "", "country_code": "", "social_profiles": { "facebook": "", "github": "", "instagram": "", "linkedin": "", "twitter": "" } }, "availability_status": "offline", "email": "support@jiguang.cn", "name": "support", "phone_number": null, "blocked": false, "identifier": "2222", "thumbnail": "", "last_activity_at": 1765441908, "custom_attributes": { // Opsional: gabungkan dan perbarui field kustom (penggabungan inkremental) "vip_level": "platinum" }, "created_at": 1765441895, "first_name": "support", "last_name": "" }

              
              curl -X PATCH https://livedesk-api.engagelab.com/api/v2/accounts/contacts/:id \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
{
    "additional_attributes":
     {
        "description": "",
        "company_name": "",
        "city": "",
        "telegram": "",
        "country": "",
        "country_code": "",
        "social_profiles": 
        {
            "facebook": "",
            "github": "",
            "instagram": "",
            "linkedin": "",
            "twitter": ""
        }
    },
    "availability_status": "offline",
    "email": "support@jiguang.cn",
    "name": "support",
    "phone_number": null,
    "blocked": false,
    "identifier": "2222",
    "thumbnail": "",
    "last_activity_at": 1765441908,
    "custom_attributes": 
    {                  // Opsional: gabungkan dan perbarui field kustom (penggabungan inkremental)
    "vip_level": "platinum"
    },
    "created_at": 1765441895,
    "first_name": "support",
    "last_name": ""
}

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Field	Type	Description
Authorization	string	Gunakan `Authorization: Basic base64(API Key:API Secret)` untuk autentikasi. Silakan buka halaman API Key untuk mendapatkan API Key dan API Secret, gabungkan keduanya dengan tanda titik dua, lalu lakukan encoding Base64.
Content-Type	application/json	Ini adalah format data permintaan. Gunakan `application/json`.

Parameter Path

Field	Type	Required	Description
account	integer	Yes	ID akun
id	integer	Yes	ID kontak

Parameter Body Permintaan

Field	Type	Required	Description
additional_attributes	Object	No	Atribut tambahan.
description	Object	No	Informasi deskriptif.
company_name	String	No	Nama perusahaan.
city	String	No	Kota.
telegram	String	No	Kontak Telegram.
country	String	No	Negara.
country_code	String	No	Kode negara.
social_profiles	String	No	Kontak media sosial.
availability_status	String	No	Status online. Nilai default adalah `offline`.
email	String	No	Alamat email.
name	String	No	Nama.
phone_number	String	No	Nomor telepon.
blocked	String	No	Menunjukkan apakah diblokir. Nilai default adalah `false`.
identifier	String	No	Pengidentifikasi unik eksternal untuk kontak, sesuai dengan UserID yang ditampilkan di antarmuka.
thumbnail	String	No	URL avatar kontak.
last_activity_at	String	No	Stempel waktu pembaruan terakhir.
created_at	String	No	Stempel waktu pembuatan.
first_name	String	No	Nama depan kontak.
last_name	Array	No	Nama belakang kontak.
custom_attributes	object	Field kustom

Contoh Respons

{ "payload": { "additional_attributes": { "description": "", "company_name": "", "city": "", "telegram": "", "country": "", "country_code": "", "social_profiles": { "facebook": "", "github": "", "instagram": "", "linkedin": "", "twitter": "" } }, "availability_status": "offline", "email": "support@jiguang.cn", "id": 318763, "name": "support", "phone_number": null, "blocked": false, "identifier": "2222", "thumbnail": "", "custom_attributes": {}, "last_activity_at": 1765441908, "created_at": 1765441895, "contact_inboxes":[ { "source_id": "src_001", "inbox": { "id": 10, "name": "Kanal Layanan Pelanggan", "channel_type": "Channel::Api" } } ] } }

              
              {
    "payload": {
        "additional_attributes": {
            "description": "",
            "company_name": "",
            "city": "",
            "telegram": "",
            "country": "",
            "country_code": "",
            "social_profiles": {
                "facebook": "",
                "github": "",
                "instagram": "",
                "linkedin": "",
                "twitter": ""
            }
        },
        "availability_status": "offline",
        "email": "support@jiguang.cn",
        "id": 318763,
        "name": "support",
        "phone_number": null,
        "blocked": false,
        "identifier": "2222",
        "thumbnail": "",
        "custom_attributes": {},
        "last_activity_at": 1765441908,
        "created_at": 1765441895,
        "contact_inboxes":[
        {
         "source_id": "src_001",
          "inbox": {
          "id": 10,
          "name": "Kanal Layanan Pelanggan",
          "channel_type": "Channel::Api"
        }
      }
    ]
    }
}

Tampilkan blok kode ini di jendela mengambang

Parameter Respons

Field	Type	Required	Description
payload	Object	No	Struktur atribut.
additional_attributes	Object	No	Atribut tambahan.
availability_status	String	No	Status online. Nilai default adalah `offline`.
email	String	No	Alamat email.
id	String	No	ID kontak.
name	String	No	Nama.
phone_number	String	No	Nomor telepon.
blocked	String	No	Menunjukkan apakah diblokir. Nilai default adalah `false`.
identifier	String	No	Pengidentifikasi unik eksternal untuk kontak, sesuai dengan UserID yang ditampilkan di antarmuka.
thumbnail	String	No	URL avatar.
custom_attributes	String	No	Atribut kontak.
created_at	String	No	Stempel waktu pembuatan.
last_activity_at	String	No	Stempel waktu pembaruan terakhir.
contact_inboxes	array	Informasi kanal terkait, hanya dikembalikan ketika `include_contact_inboxes=true`.
source_id	String	No	ID sumber.
inbox	Object	No	Informasi kotak masuk.
id	Integer	No	ID kotak masuk.
name	String	No	Nama kotak masuk.
channel_type	String	No	Jenis kanal.