Referensi: kontak

API kontak CRM publik untuk membuat, membaca, memperbarui, dan penyelesaian identitas omnichannel.

Ringkasan

Pakai Contacts API untuk catatan CRM yang disimpan di Wazapin.

contacts adalah sumber daya pelanggan kanonis.
Pakai POST /v1/contacts/lookup untuk menyelesaikan kontak tersimpan yang ada dengan satu atau beberapa pengidentifikasi.
Pakai POST /v1/channels/{channelID}/contacts/lookup hanya saat kamu butuh pencarian profil spesifik penyedia dari suatu saluran.

Header umum

field string (required) — Header autentikasi utama untuk permintaan API publik.
field string (required) — Pakai application/json.

Endpoint kontak kanonis

Endpoint	Tujuan
`POST /v1/contacts`	Buat atau lakukan upsert catatan kontak
`GET /v1/contacts`	Daftar kontak yang disimpan
`GET /v1/contacts/{contactID}`	Dapatkan satu kontak berdasarkan ID kontak internal
`PATCH /v1/contacts/{contactID}`	Perbarui kontak yang disimpan
`DELETE /v1/contacts/{contactID}`	Hapus kontak yang disimpan
`GET /v1/contacts/phone/{phone}`	Dapatkan satu kontak berdasarkan nomor telepon
`POST /v1/contacts/lookup`	Selesaikan kontak yang disimpan berdasarkan pengidentifikasi omnichannel
`GET /v1/contacts/{contactID}/identities`	Daftar identitas yang disambungkan ke kontak
`GET /v1/contacts/{contactID}/notes`	Daftar catatan
`POST /v1/contacts/{contactID}/notes`	Buat catatan
`GET /v1/contacts/{contactID}/tags`	Daftar tag yang ditetapkan
`POST /v1/contacts/{contactID}/tags`	Tetapkan tag
`PUT /v1/contacts/{contactID}/consent/{channel}`	Upsert status persetujuan (consent)
`GET /v1/contacts/{contactID}/consents`	Daftar baris persetujuan
`GET /v1/contacts/{contactID}/suppressions`	Daftar penekanan (suppressions)
`POST /v1/contacts/{contactID}/suppressions`	Buat atau perbarui penekanan (suppression)

Membuat kontak

POST /v1/contacts

Request example:

curl -X POST "https://api.wazapin.com/v1/contacts" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+6281234567890",
    "name": "Ujang",
    "email": "ujang@example.com",
    "external_source": "shopify",
    "external_id": "cust_123",
    "custom_fields": {
      "tier": "premium"
    }
  }'

Response example:

{
  "id": "cnt_123",
  "phone_number": "+6281234567890",
  "name": "Ujang",
  "email": "ujang@example.com",
  "external_source": "shopify",
  "external_id": "cust_123"
}

Menyelesaikan kontak

POST /v1/contacts/lookup

Pakai endpoint ini ketika sistem kamu mengetahui satu atau beberapa pengidentifikasi, tetapi belum mengetahui contactID internal Wazapin.

Jenis pengidentifikasi yang didukung:

contact_id
phone
whatsapp
wa_id
email
external_id

Ketika type adalah external_id, sertakan source.

Selesaikan berdasarkan nomor telepon

curl -X POST "https://api.wazapin.com/v1/contacts/lookup" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "identifiers": [
      {
        "type": "phone",
        "value": "+6281234567890"
      }
    ]
  }'

Selesaikan berdasarkan identitas eksternal

curl -X POST "https://api.wazapin.com/v1/contacts/lookup" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "identifiers": [
      {
        "type": "external_id",
        "source": "shopify",
        "value": "cust_123"
      }
    ]
  }'

Respons penyelesaian

{
  "id": "cnt_123",
  "phone_number": "+6281234567890",
  "name": "Ujang",
  "email": "ujang@example.com"
}

{
  "error": "contact not found",
  "code": "not_found"
}

{
  "error": "contact identifiers resolve to different contacts",
  "code": "conflict"
}

Memperbarui kontak

PATCH /v1/contacts/{contactID}

curl -X PATCH "https://api.wazapin.com/v1/contacts/cnt_123" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Ujang Updated",
    "email": "ujang-updated@example.com"
  }'

Pencarian penyedia versus penyelesaian CRM

Pakai endpoint yang tepat untuk pekerjaan yang tepat:

POST /v1/contacts/lookup
- menyelesaikan kontak CRM yang disimpan di dalam Wazapin
POST /v1/channels/{channelID}/contacts/lookup
- mencari data profil spesifik penyedia dari saluran terhubung

Jika kamu sedang membangun alur kerja CRM, otomatisasi, segmentasi, atau data pelanggan, pakai lookup.