Thêm mới khách hàng
1. Tổng quan
API này dùng để tạo mới một khách hàng trong hệ thống CRM.
- Endpoint:
/api/v6.1/account
- Phương thức:
POST
- Xác thực: Cần gửi
X-API-KEY
trong header
2. Request
2.1. Headers
Tên | Loại | Mô tả |
---|---|---|
X-API-KEY | String | API Key để xác thực |
Content-Type | String | application/json |
2.2. Body Parameters
Trường | Loại | Mô tả |
---|---|---|
account_code | string | Mã khách hàng |
email | string | Email khách hàng |
billing_address_street | string | Địa chỉ khách hàng |
phone_office | string | Số điện thoại văn phòng |
last_contact_name | string | Tên liên hệ cuối cùng |
last_contact_phone | string | Số điện thoại liên hệ cuối cùng |
last_contact_email | string | Email liên hệ cuối cùng |
last_contact_title | string | Chức danh liên hệ cuối cùng |
last_contact_birthdate | string | Ngày sinh liên hệ cuối cùng (YYYY-MM-DD) |
website | string | Website của khách hàng |
account_name | string | Tên khách hàng |
birthday | string | Ngày sinh của khách hàng (YYYY-MM-DD) |
description | string | Mô tả khách hàng |
sic_code | string | Mã số thuế khách hàng |
publisher_code | string | Mã tiếp thị |
is_private | integer | 1: Riêng tư, 0: Công khai |
is_create_care | integer | 1: Tạo chăm sóc, 0: Không |
referrer_type | string | Loại người giới thiệu |
referrer_ref_code | string | Mã người giới thiệu |
contacts | array | Danh sách liên hệ |
account_manager_username | string | Tên người quản lý khách hàng |
account_type_names | array | Danh sách loại khách hàng |
account_source_names | array | Danh sách nguồn khách hàng |
industry_names | array | Danh sách ngành nghề |
relation_name | string | Mối quan hệ khách hàng |
country_name | string | Quốc gia |
province_name | string | Tỉnh/Thành phố |
district_name | string | Quận/Huyện |
ward_name | string | Phường/Xã |
custom_fields | object | Các trường dữ liệu tùy chỉnh |
2.3. Ví dụ Request
curl --location 'https://linhpq.getflycrm.com/api/v6.1/account' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: YOUR_API_KEY' \
--header 'Cookie: v6_getflycrm_session=YOUR_SESSION_COOKIE' \
--data-raw '{
"account_code": "KH_DEMO_12345",
"email": "[email protected]",
"billing_address_street": "123 Đường ABC, Quận XYZ",
"phone_office": "0909123456",
"last_contact_name": "Nguyễn Văn A",
"last_contact_phone": "0912345678",
"last_contact_email": "[email protected]",
"last_contact_title": "Giám đốc",
"last_contact_birthdate": "1980-05-10",
"website": "https://example.com",
"account_name": "Công ty TNHH XYZ",
"birthday": "1985-07-20",
"description": "Khách hàng tiềm năng",
"sic_code": "123456789",
"publisher_code": "PUB12345",
"is_private": 1,
"is_create_care": 1,
"referrer_type": "USER",
"referrer_ref_code": "referrer_abc",
"contacts": [
{
"first_name": "Trần Th ị B",
"title": "Thư ký",
"phone_home": "0987654321",
"birthdate": "1992-03-15",
"email": "[email protected]",
"gender_name": 2,
"description": "Liên hệ chính",
"is_primary": 1
}
],
"account_manager_username": "manager_xyz",
"account_type_names": [
"Khách VIP",
"Doanh nghiệp lớn"
],
"account_source_names": [
"Google Ads",
"Facebook Marketing"
],
"industry_names": [
"Công nghệ",
"Bất động sản"
],
"relation_name": "Đối tác",
"country_name": "Việt Nam",
"province_name": "Hà Nội",
"district_name": "Ba Đình",
"ward_name": "Phường Kim Mã",
"custom_fields": {
"Ma_don_hang": "ORDER12345"
}
}'
3. Response
3.1. Cấu trúc JSON trả về
{
"message": "Thêm mới thành công",
"data": {
"account_id": 12345,
"account_code": "KH_DEMO_12345"
}
}
3.2. Mô tả các trường dữ liệu trả về
Trường | Loại | Mô tả |
---|---|---|
message | string | Thông báo kết quả |
data | object | Thông tin khách hàng vừa tạo |
data.account_id | integer | ID của khách hàng mới |
data.account_code | string | Mã khách hàng mới |
4. Lưu ý
- API yêu cầu xác thực bằng
X-API-KEY
. - Các trường dữ liệu phải đúng định dạng để tránh lỗi.
- Mã khách hàng
account_code
cần đảm bảo duy nhất trong hệ thống. - Có thể thêm danh sách liên hệ
contacts
khi tạo mới khách hàng.
Tài liệu này cung cấp thông tin chi tiết về API tạo mới khách hàng, giúp dễ dàng tích hợp vào hệ thống.