Tạo mới trường thông tin tùy biến

Lưu ý

1. Ứng dụng cần được OA cấp quyền "Quản lý trường thông tin người dùng" để sử dụng API này.
2. Key và data_type là thông tin không thể thay đổi sau khi tạo.
3. Không thể tạo trường thông tin với data_type đặc biệt của hệ thống (id, tag, gender, location).

HTTP request

• URL: https://openapi.zalo.me/v3.0/oa/userfield/create
• Method: POST
• Response Type: text/json

Example request

curl --location --request POST 'https://openapi.zalo.me/v3.0/oa/userfield/create' \
--header 'access_token: <your_access_token>' \
--header 'Content-Type: application/json' \
--data '{
    "key" : "ngay_dat_hang",
    "name": "Ngày đặt hàng",
    "data_type": "datetime",
    "description": "Ngày khách hàng đặt đơn hàng", 
    "status": "active",
    "additional_format": "dd/MM/yyyy"
}'

Tham số header

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
access_token	string	yes	Token cho phép ứng dụng đại diện OA gọi API

Cấu trúc body của request

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
key	string	yes	Khóa của trường thông tin Thông tin này sẽ không thể thay đổi sau khi khởi tạo thành công
name	string	yes	Tên trường thông tin
data_type	string	yes	Loại dữ liệu của trường thông tin. Chi tiết xem bảng Mô tả data_type bên dưới. Thông tin này sẽ không thể thay đổi sau khi khởi tạo thành công
description	string	no	Mô tả trường thông tin
status	string	no	Trạng thái của trường thông tin - "active": Đang hoạt động - "inactive": Tạm ngưng Mặc định là "active" nếu không được khai báo
additional_format	string	no	Cài đặt bổ sung cho data_type là datetime. Chi tiết xem bảng Format datetime bên dưới. Ví dụ: "additional_format": "dd/MM/yyyy"
additional_fields	object	no	Cài đặt bổ sung cho data_type là table Ví dụ: "additional_fields": [ { "key": "da_thanh_toan_chua", "data_type": "boolean" }, { "key": "ngay_thanh_toan", "data_type": "datetime", "additional_format": "dd/MM/yyyy" } ]

Mô tả data_type

Data Type	Mô tả	Giới hạn
boolean	Đúng/Sai	Giá trị: true/false
number	Số	Cho phép chứa giá trị: - Số nguyên (integer) - Số thập phân (float) tối đa 3 chữ số sau dấu phẩy
text	Văn bản	Tối đa 255 kí tự
datetime	Thời gian	Xem bảng Format datetime bên dưới
table	Bảng	- JSON (1 cấp) - Tối đa 5 cặp key-value - Các key thuộc bảng sẽ không thể xóa/sửa sau khi khởi tạo, chỉ cho phép thêm mới key
email	Email	Ví dụ: abc@example.com
phone	Số điện thoại	Format: country_code + phone_number Ví dụ: 849xxxxxxxx
url	Đường dẫn	Ví dụ: https://example.com

Format datetime

Format	Ví dụ	Mô tả
dd/MM/yyyy	31/12/2023	Ngày tháng với dấu gạch chéo
dd/MM/yyyy HH:mm:ss	31/12/2023 23:59:59	Ngày tháng và giờ với dấu gạch chéo
dd-MM-yyyy	31-12-2023	Ngày tháng với dấu gạch ngang
dd-MM-yyyy HH:mm:ss	31-12-2023 23:59:59	Ngày tháng và giờ với dấu gạch ngang
yyyy-MM-dd	2023-12-31	Định dạng ISO8601 cho ngày
yyyy-MM-ddTHH:mm:ss	2023-12-31T23:59:59	Định dạng ISO8601 cho ngày và giờ

Example response

{
    "error": 0,
    "message": "success",
    "data": {
        "name": "Ngày đặt hàng",
        "key": "ngay_dat_hang",
        "data_type": "datetime",
        "description": "Ngày khách hàng đặt đơn hàng",
        "status": "active",
        "additional_format": "dd/MM/yyyy"
    }
}

Cấu trúc response

Tham số	Kiểu dữ liệu	Mô tả
error	integer	Mã lỗi (0 nếu thành công)
message	string	Thông báo kết quả
data	object	Thông tin trường đã tạo