Chuyển tới nội dung chính

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ênLoạiMô tả
X-API-KEYStringAPI Key để xác thực
Content-TypeStringapplication/json

2.2. Body Parameters

TrườngLoạiMô tả
account_codestringMã khách hàng
emailstringEmail khách hàng
billing_address_streetstringĐịa chỉ khách hàng
phone_officestringSố điện thoại văn phòng
last_contact_namestringTên liên hệ cuối cùng
last_contact_phonestringSố điện thoại liên hệ cuối cùng
last_contact_emailstringEmail liên hệ cuối cùng
last_contact_titlestringChức danh liên hệ cuối cùng
last_contact_birthdatestringNgày sinh liên hệ cuối cùng (YYYY-MM-DD)
websitestringWebsite của khách hàng
account_namestringTên khách hàng
birthdaystringNgày sinh của khách hàng (YYYY-MM-DD)
descriptionstringMô tả khách hàng
sic_codestringMã số thuế khách hàng
publisher_codestringMã tiếp thị
is_privateinteger1: Riêng tư, 0: Công khai
is_create_careinteger1: Tạo chăm sóc, 0: Không
referrer_typestringLoại người giới thiệu
referrer_ref_codestringMã người giới thiệu
contactsarrayDanh sách liên hệ
account_manager_usernamestringTên người quản lý khách hàng
account_type_namesarrayDanh sách loại khách hàng
account_source_namesarrayDanh sách nguồn khách hàng
industry_namesarrayDanh sách ngành nghề
relation_namestringMối quan hệ khách hàng
country_namestringQuốc gia
province_namestringTỉnh/Thành phố
district_namestringQuận/Huyện
ward_namestringPhường/Xã
custom_fieldsobjectCá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ườngLoạiMô tả
messagestringThông báo kết quả
dataobjectThông tin khách hàng vừa tạo
data.account_idintegerID của khách hàng mới
data.account_codestringMã 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.