Tạo trường định nghĩa dữ liệu cơ hội

Endpoint

POST /api/v6.1/opportunity/define_field

Cách gọi API

curl --location 'https://demo.getflycrm.com/api/v6.1/opportunity/define_field' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: YOUR_API_KEY' \
--data-raw '{
    "source_id": 8,
    "field_name": "budget",
    "field_htmltype": "numericinput",
    "field_requirenotnull": 0,
    "field_description": "Ngân sách khách hàng"
}'

Tham số trong body

Trường	Kiểu	Bắt buộc	Mô tả
source_id	integer	Có	ID chiến dịch (campaign_id) — trường sẽ thuộc chiến dịch này
field_name	string	Có	Tên kỹ thuật của trường (chữ thường, không dấu, dùng _)
field_htmltype	string	Có	Kiểu hiển thị của trường (xem bảng bên dưới)
field_description	string	Không	Nhãn hiển thị / mô tả của trường
field_requirenotnull	integer	Không	Bắt buộc nhập: 1 = có, 0 = không (mặc định: 0)
field_ismultiple	integer	Không	Cho phép chọn nhiều giá trị (chỉ áp dụng với select, checkbox): 1 = có
check_duplicate	integer	Không	Kiểm tra trùng lặp: 1 = có, 0 = không
field_hidden	integer	Không	Ẩn trường: 1 = ẩn, 0 = hiện (mặc định: 0)
define_field_lists	array	Không	Danh sách lựa chọn (bắt buộc với select và checkbox)
define_field_lists.*.list_value	string	Không	Giá trị của một lựa chọn

Các kiểu trường (field_htmltype)

Giá trị	Mô tả
textinput	Nhập văn bản ngắn
numericinput	Nhập số
textarea	Nhập văn bản dài
select	Dropdown chọn một/nhiều
checkbox	Checkbox chọn một/nhiều
datetime	Ngày giờ
date	Ngày
href	Đường dẫn URL

Phản hồi mẫu

{
  "message": "Thêm mới thành công",
  "data": {
    "define_field_id": 14
  }
}

Ghi chú

• source_type luôn được tự động gán là 1 (Campaign) — không cần truyền.
• Với trường select hoặc checkbox, bắt buộc phải kèm theo define_field_lists chứa ít nhất một lựa chọn.
• field_name nên đặt theo quy tắc snake_case, ví dụ: budget, contact_channel, purchase_reason.