Lead
Các API liên quan đến đối tượng Leads
Last updated
Các API liên quan đến đối tượng Leads
Last updated
POST
/{domain}/api/v1/lead
Tạo mới Lead
Headers
Name | Value |
---|---|
Body
STT | Param | Kiểu | Độ dài | Ghi chú |
---|---|---|---|---|
Mẫu body JSON tạo lead
Kết quả phản hồi Trong đối tượng lead trả về có chứa ID chính là Lead Id dùng để cập nhật hoặc thực thi các tác vụ khác liên quan
PUT
/{domain}/api/v1/lead/{leadId}
Cập nhật 1 lead với {leadId} là ID từ quá trình tạo mới hoặc quét dữ liệu đồng bộ từ trước
Headers
Body
Mẫu ví dụ body Json cập nhật LeadID: 414856017
PUT: /{domain}/api/v1/lead/414856017
Kết quả phản hồi
GET
/{domain}/api/v1/lead/{leadId}
<Description of the endpoint>
Headers
Response
GET
/{domain}/api/v1/leads
Lấy danh sách các leads
Headers
Parameter
Mẫu dữ liệu phản hồi
Các API bổ sung cho lead
GET
/{domain}/api/v1/lead/status
Danh sách các trạng thái lead đã cấu hình trên hệ thống
Trong đó:
label: Tên trạng thái
id: ID trạng thái
status_type: Kiểu trạng thái. 1: Đầu tiên, ,0 Giữa (đổi vị trí thoải mái-- index các loại), 2: Converted (index to nhất), 3: Unqualify
Headers
Kết quả minh họa
GET
/{domain}/api/v1/lead/unqualified-reason
Danh sách id các lý do không đạt đã được cấu hình cho lead
Headers
Response
GET
/{domain}/lead/labels
<Description of the endpoint>
Headers
Response
Name | Value |
---|---|
STT | Param | Type | Length | Description |
---|---|---|---|---|
Name | Value |
---|---|
Name | Value |
---|---|
Param | Ghi chú |
---|---|
Name | Value |
---|---|
Name | Value |
---|---|
Name | Value |
---|---|
Content-Type
application/json
Authorization
Bearer <token>
1*
lead
object
Đối tượng chứa thông tin lead
….
2
subject (*)
text
250
Tiêu đề
3
phone (*)
tel
50
Số điện thoại của khách hàng
4
email (*)
50
Email của khách hàng
5
service_id (**)
Int
10
Dịch vụ tiếp nhận Lead
6
group_id (**)
Int
10
ID bộ phận tiếp nhận
7
assignee_id (**)
Int
10
ID chuyên viên tiếp nhận
8
lead_status_id
Int
10
ID trạng thái lead (Mặc định không điền sẽ lấy trạng thái đầu
9
estimated_closed_date
DateTime
Dự kiến hoàn thành (Định dạng YYYY-MM-DD HH:mm:ss)
10
lead_label
Array
Mảng ID label của lead Dạng [1,2,3]
11
custom_fields
Array
Mảng custom_fields tương tự tạo ticket
12
comment
Text
5000
Nội dung ghi chú
13
unqualify_reason
Int
10
ID của lý do không đạt (Chỉ áp dụng nếu lead_status_id ở trạng thái cuối)
Content-Type
application/json
Authorization
Bearer <token>
1*
lead
object
Đối tượng chứa thông tin lead
….
2
subject
text
250
Tiêu đề
3
assignee_id
Int
10
ID chuyên viên tiếp nhận
4
lead_status_id
Int
10
ID trạng thái lead (Mặc định không điền sẽ lấy trạng thái đầu
5
estimated_closed_date
DateTime
Dự kiến hoàn thành (Định dạng YYYY-MM-DD HH:mm:ss)
6
lead_label
Array
Mảng ID label của lead Dạng [1,2,3]
7
custom_fields
Array
Mảng custom_fields tương tự tạo ticket
8
comment (*)
OBJECT
Object đối tượng comment
9
comment.body
Text
5000
Nội dung comment
10
comment.is_public
Int
1
Trạng thái comment 0: Ghi chú 1: Public (VD: Gửi email cho người yêu cầu …)
11
comment.author_id
Int
10
ID của người bình luận
12
unqualify_reason
Int
10
ID của lý do không đạt (Chỉ áp dụng nếu lead_status_id ở trạng thái cuối)
Content-Type
application/json
Authorization
Bearer <token>
Content-Type
application/json
Authorization
Bearer <token>
requester_id
ID Người yêu cầu
assignee_id
ID Chuyên viên
service_id
ID dịch vụ
page
Trang số (mặc định 1)
count
Số bản ghi /trang (mặc định 50, max 500)
created_since
Ngày tạo từ (Kiểu Time TZ) Vd: 2024-06-01T00:00:00Z
created_to
Ngày tạo tới (Kiểu Time TZ) Vd: 2024-06-01T00:00:00Z
updated_since
Ngày cập nhật từ (Kiểu Time TZ) Vd: 2024-06-01T00:00:00Z
updated_to
Ngày cập nhật tới (Kiểu Time TZ) Vd: 2024-06-01T00:00:00Z
convert_since
Ngày chuyển đổi thành deal (từ lead) (Kiểu Time TZ) Vd: 2024-06-01T00:00:00Z
convert_to
Ngày chuyển đổi thành deal tới (Kiểu Time TZ) Vd: 2024-06-01T00:00:00Z
status_ids
Trạng thái leads, chọn nhiều cách nhau bởi dấu phẩy VD: 12 hoặc 12,34,56
convert_type
Trạng thái chuyển đổi từ lead sang deal
1: Chuyển thành Lead, 2: Chuyển thành Không đạt
Content-Type
application/json
Authorization
Bearer <token>
Content-Type
application/json
Authorization
Bearer <token>
Content-Type
application/json
Authorization
Bearer <token>