SubizTài liệu API
Khách hàng

API 4.1

Cập nhật thông tin khách hàng

Thay đổi thuộc tính của khách hàng, như tên, email hoặc số điện thoại.

POSThttps://api.subiz.com.vn/4.1/users/{uid}

Dùng endpoint này để giữ khách hàng đồng bộ với hệ thống của bạn, ví dụ sau khi khách hàng đổi email trong CRM.

Body yêu cầu

Chỉ gửi các thuộc tính bạn muốn thay đổi.

Trường Kiểu Mô tả
uid (đường dẫn) string ID user Subiz.
attributes array Các thuộc tính cần thay đổi. Mỗi phần tử có key và một giá trị.
attributes[].key string Khóa thuộc tính, như fullname. Xem Thuộc tính thường dùng.
attributes[].text string Giá trị mới cho thuộc tính văn bản. Dùng number, boolean hoặc datetime cho kiểu khác; xem Kiểu giá trị.
{
  "attributes": [
    {
      "key": "fullname",
      "text": "Alex Example"
    },
    {
      "key": "emails",
      "text": "alex.new@example.com"
    }
  ]
}

Subiz chỉ đọc một vài trường từ body, chủ yếu là attributes. Các trường khác, như id, created hoặc labels, bị bỏ qua nên bạn không thể thay đổi chúng ở đây. Đừng gửi lại toàn bộ đối tượng khách hàng đã đọc trước đó.

Phản hồi

Yêu cầu thành công trả HTTP 200 cùng khách hàng đã cập nhật. Một số trường:

{
  "id": "user_example",
  "account_id": "account_example",
  "attributes": [
    {
      "key": "fullname",
      "text": "Alex Example"
    },
    {
      "key": "emails",
      "text": "alex.new@example.com"
    }
  ]
}

Khi dữ liệu khách hàng thay đổi, webhook đã đăng ký nhận sự kiện user_info_updated. Các cập nhật liên tiếp nhanh có thể được gộp thành một sự kiện. Xem Thông tin khách hàng được cập nhật.

Giới hạn và lỗi

Một yêu cầu có thể chứa tối đa 1.000 thuộc tính, và mỗi giá trị tối đa 2.048 byte. Xem Giới hạn thuộc tính khách hàng.

uid không hợp lệ sẽ trả lỗi. Nếu chỉ có định danh kênh của khách hàng, trước tiên lấy ID user bằng Tìm hoặc tạo theo định danh kênh. Xem Xử lý lỗi để biết định dạng lỗi.

Yêu cầu HTTP

Thay YOUR_UID bằng ID user và YOUR_ACCESS_TOKEN bằng token của bạn.

POST https://api.subiz.com.vn/4.1/users/YOUR_UID
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

{
  "attributes": [
    {
      "key": "fullname",
      "text": "Alex Example"
    }
  ]
}