Zalo — Trường thông tin người theo dõi

Danh sách trường tùy chỉnh (List user fields) — zalo.list_user_fields

List the OA's custom user fields.

Tác động	Rủi ro	Cần duyệt	Idempotent	Scopes
NONE	low	không	có	—

Input

Không có input.

Field thêm: bỏ qua.

Output

Field	Nhãn	Kiểu	Mô tả
data	Kết quả	object	The OA's user fields.
data.fields		array of object	User fields, system and custom.
data.fields[].key		string	Key of the field.
data.fields[].name		string	Name of the field.
data.fields[].description		string	What the field is for.
data.fields[].status		string	active or inactive.
data.fields[].data_type		string	Data type: boolean, number, text, datetime, table, email, phone or url; system fields can also be id, tag, gender or location.
data.fields[].value_unique		boolean	True when values must be unique. Only user_external_id and user_id today.
data.fields[].field_type		string	system or oa_custom.
data.fields[].additional_format		string	Date format, e.g. dd/MM/yyyy. Only for datetime fields.
data.fields[].additional_fields		array of object	Columns of the table. Only for table fields.
data.fields[].additional_fields[].key		string	Key of the column.
data.fields[].additional_fields[].data_type		string	Data type of the column.
data.fields[].additional_fields[].additional_format		string	Date format of the column. Only for datetime columns.

Tạo trường tùy chỉnh (Create user field) — zalo.create_user_field

Create a custom user field.

Tác động	Rủi ro	Cần duyệt	Idempotent	Scopes
WRITE	medium	có	không	—

Input

Field	Nhãn	Kiểu	Bắt buộc	Mô tả
name	Tên trường	string	có	Custom field name.
display_name	Tên hiển thị	string	có	Name shown in OA Manager.
type	Kiểu dữ liệu	string	có	Field type, e.g. text, number, date or choice.
choices	Lựa chọn	array of string	không	Options for choice fields.

Field thêm: bỏ qua.

Output

Field	Nhãn	Kiểu	Mô tả
data	Kết quả	object	The field that was created.
data.key		string	Key of the field.
data.name		string	Name of the field.
data.description		string	What the field is for.
data.status		string	active or inactive.
data.data_type		string	Data type: boolean, number, text, datetime, table, email, phone or url; system fields can also be id, tag, gender or location.
data.value_unique		boolean	True when values must be unique. Only user_external_id and user_id today.
data.field_type		string	system or oa_custom.
data.additional_format		string	Date format, e.g. dd/MM/yyyy. Only for datetime fields.
data.additional_fields		array of object	Columns of the table. Only for table fields.
data.additional_fields[].key		string	Key of the column.
data.additional_fields[].data_type		string	Data type of the column.
data.additional_fields[].additional_format		string	Date format of the column. Only for datetime columns.

Cập nhật trường tùy chỉnh (Update user field) — zalo.update_user_field

Change a custom user field's display name or choices.

Tác động	Rủi ro	Cần duyệt	Idempotent	Scopes
WRITE	medium	có	không	—

Input

Field	Nhãn	Kiểu	Bắt buộc	Mô tả
name	Tên trường	string	có	Custom field name.
display_name	Tên hiển thị	string	không	Name shown in OA Manager.
choices	Lựa chọn	array of string	không	Options for choice fields.

Field thêm: bỏ qua.

Output

Field	Nhãn	Kiểu	Mô tả
data	Kết quả	object	The field after the update, with its full current settings.
data.key		string	Key of the field.
data.name		string	Name of the field.
data.description		string	What the field is for.
data.status		string	active or inactive.
data.data_type		string	Data type: boolean, number, text, datetime, table, email, phone or url; system fields can also be id, tag, gender or location.
data.value_unique		boolean	True when values must be unique. Only user_external_id and user_id today.
data.field_type		string	system or oa_custom.
data.additional_format		string	Date format, e.g. dd/MM/yyyy. Only for datetime fields.
data.additional_fields		array of object	Columns of the table. Only for table fields.
data.additional_fields[].key		string	Key of the column.
data.additional_fields[].data_type		string	Data type of the column.
data.additional_fields[].additional_format		string	Date format of the column. Only for datetime columns.

Xóa trường tùy chỉnh (Delete user field) — zalo.delete_user_field

Delete a custom user field and the values users stored in it.

Tác động	Rủi ro	Cần duyệt	Idempotent	Scopes
WRITE	high	có	không	—

Input

Field	Nhãn	Kiểu	Bắt buộc	Mô tả
name	Tên trường	string	có	Custom field name.

Field thêm: bỏ qua.

Output

Field	Nhãn	Kiểu	Mô tả
data	Kết quả	object	Not returned: Zalo replies only error and message.