Documentation

crm.contact.userfield.add

crm.contact.userfield.add(fields)

Creates a new user field for contacts.

System limitation for field name - 20 characters. Prefix UF_CRM_is always added to the user field name. As a result, the actual name length - 13 characters.

Parameters

Parameter Description
fields Set of fields - is an array ("field"=>"value"[, ...]), containing description of user field.

Full description of fields can be retuned by calling crm.userfield.fields method.

Example #1

BX24.callMethod(
	"crm.contact.userfield.add", 
	{
		fields: 
		{
			"FIELD_NAME": "MY_STRING",
			"EDIT_FORM_LABEL": "My string",
			"LIST_COLUMN_LABEL": "My string",
			"USER_TYPE_ID": "string",
			"XML_ID": "MY_STRING",
			"SETTINGS": { "DEFAULT_VALUE": "Hello, world!" }
		}
	}, 
	function(result) 
	{
		if(result.error())
			console.error(result.error());
		else
			console.dir(result.data());
	}
);

Example #2

BX24.callMethod(
	"crm.contact.userfield.add", 
	{
		fields: 
		{
			"FIELD_NAME": "MY_LIST",
			"EDIT_FORM_LABEL": "My list",
			"LIST_COLUMN_LABEL": "My list",
			"USER_TYPE_ID": "enumeration",
			"LIST": [ { "VALUE": "Element #1" }, { "VALUE": "Element #2" }, { "VALUE": "Element #3" }, { "VALUE": "Element #4" }, { "VALUE": "Element #5" } ],
			"XML_ID": "MY_LIST",
			"SETTINGS": { "LIST_HEIGHT": 3 }
		}
	}, 
	function(result) 
	{
		if(result.error())
			console.error(result.error());
		else
			console.dir(result.data());
	}
);


User Comments

User comments are not part of official documentation. Use information provided by other users in the comments at your own risk.

The User Comments section is not to be used as a feature discussion board. Only registered users can post comments. Your comment will be visible once it has been approved by the moderator.
© «Bitrix Inc.», 2001-2019, «Bitrix Inc.», 2019