Trong API, khách hàng là một user. Agent là agent của bạn và không được tạo ở đây.
Dùng endpoint này để thêm khách hàng từ hệ thống của bạn, như một liên hệ trong CRM hoặc người mới đăng ký. Nếu khách hàng đến từ kênh đã kết nối như Facebook hoặc Zalo, hãy dùng Tìm hoặc tạo theo định danh kênh để tránh trùng lặp.
Trước khi bắt đầu
- Lấy Bearer access token. Khách hàng được tạo trong tài khoản của token.
- Dùng khóa thuộc tính đã định nghĩa trong tài khoản, với giá trị đúng kiểu.
Body yêu cầu
| Trường | Kiểu | Mô tả |
|---|---|---|
attributes |
array | Dữ liệu khách hàng, mỗi phần tử là một thuộc tính. |
attributes[].key |
string | Khóa thuộc tính, như fullname. |
attributes[].text |
string | Giá trị cho thuộc tính văn bản. Dùng number, boolean hoặc datetime cho các kiểu khác. |
channel |
string | Tùy chọn. Kênh của định danh bên ngoài, như facebook. |
channel_source |
string | Tùy chọn. Trang hoặc tài khoản đã kết nối trên kênh đó. |
profile_id |
string | Tùy chọn. ID của khách hàng trên kênh đó. |
Các trường khác, như id hoặc account_id, bị bỏ qua.
{
"attributes": [
{
"key": "fullname",
"text": "Alex Example"
},
{
"key": "emails",
"text": "alex@example.com"
},
{
"key": "phones",
"text": "+84900000000"
}
]
}
Thuộc tính thường dùng
Các khóa có sẵn này tồn tại trong mọi tài khoản. Xem Định dạng khách hàng và thuộc tính để biết kiểu giá trị và cách lưu nhiều giá trị.
| Khóa | Kiểu | Mô tả |
|---|---|---|
fullname |
text | Họ và tên. |
display_name |
text | Tên hiển thị. |
emails |
text | Địa chỉ email. |
phones |
text | Số điện thoại. |
address, city, district |
text | Địa chỉ. |
gender |
text | Giới tính. |
job_title |
text | Chức danh. |
birthdate |
datetime | Ngày sinh. |
Một số thuộc tính có sẵn, như created hoặc last_message_sent, do Subiz đặt và là chỉ đọc.
Phản hồi
Yêu cầu thành công trả HTTP 200 cùng khách hàng mới. Một số trường:
{
"id": "user_example",
"account_id": "account_example",
"attributes": [
{
"key": "fullname",
"text": "Alex Example"
}
]
}
Lưu lại id. Bạn cần nó để đọc, cập nhật hoặc nhắn tin cho khách hàng này.
Mỗi yêu cầu tạo một bản ghi mới. Để thay đổi khách hàng đã có, dùng Cập nhật thông tin khách hàng thay vì tạo lại.
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 và Xử lý lỗi.
Yêu cầu HTTP
Thay YOUR_ACCESS_TOKEN bằng token của bạn.
POST https://api.subiz.com.vn/4.0/users
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json
{
"attributes": [
{
"key": "fullname",
"text": "Alex Example"
}
]
}