Skip to navigation

Tạo khách hàng

Scope yêu cầu: customer:write. Agent gắn với key cần quyền tạo (crm.customer → create). Response chỉ trả về customerId vừa tạo — gọi Chi tiết khách hàng để lấy đầy đủ dữ liệu.

Headers

X-Api-KeystringRequired

Request

This endpoint expects an object.
lifecycleStagesstringOptional

Mã giai đoạn hành trình — tenant có thể tự cấu hình (xem Cấu hình khách hàng → Hành trình). Mẫu mặc định: subscriber (Đăng ký), lead (Tiềm năng), qualifiedLead (Đủ điều kiện), opportunity (Cơ hội bán hàng), official (Chính thức), evangelist (Trung thành), other (Khác).

statusstringOptional

Mã trạng thái khách hàng — tenant có thể tự cấu hình (xem Cấu hình khách hàng → Trạng thái). Tuỳ chọn khi tạo mới — bỏ trống sẽ lấy trạng thái đầu tiên theo cấu hình của tenant. Mẫu mặc định: active (Hoạt động), inactive (Không hoạt động), atRisk (Rủi ro), lost (Rời bỏ).

fullNamestringOptional<=200 characters
phonestringOptional

Định dạng E.164.

emailstringOptionalformat: "email"<=254 characters
dateOfBirthdatetimeOptional
genderstringOptional

Mã giá trị lựa chọn của thuộc tính Giới tính.

customerSourcestringOptional

Mã giá trị lựa chọn của thuộc tính Nguồn khách hàng.

descriptionstringOptional<=2000 characters

Ghi chú.

avatarUrlstringOptional<=2048 characters
attributesmap from strings to anyOptional

Thuộc tính tuỳ chỉnh của tenant, khoá theo fieldCode (mã thuộc tính — không phải slot lưu trữ nội bộ valueKey). Mã không tồn tại hoặc gửi thẳng slot thô → 422 CUSTOMER_ATTRIBUTE_UNKNOWN.

socialIdsmap from strings to stringsOptional
assignedAgentIdstringOptional

uid của agent phụ trách. Bỏ trống khi tạo mới = khách hàng chưa gán cho ai (key của agent có phạm vi dữ liệu MINE/GROUP sau đó sẽ không đọc lại được khách hàng này).

relatedAgentIdslist of stringsOptional
relatedCustomerUidslist of stringsOptional
tagIdslist of stringsOptional
groupIdslist of stringsOptional
refIdstringOptional

Mã tham chiếu ngoài.

Response

Đã tạo — {customerId, success}.

customerIdstringOptional
successbooleanOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
503
Service Unavailable Error