crm.contact.userfield.update

Scope: catalog Permissions to execute: for all

crm.contact.userfield.update(id, fields)

Updates an existing user field for contacts.

Parameters

Parameter	Description
id	User field ID.
fields	Set of fields - is an array ("updated field"=>"value"[, ...]), where "updated field" can have values, returned by crm.userfield.fields.
LIST	Contains set of list values for additional custom List fields. Indicated when creating/updating a field. Each value is an array with fields: VALUE - list item value. Field is required when a new item is created. SORT - sorting. DEF - when set as Y, then list item is a default value. Multiple field can have several DEF=Y. For a single value field, first item is deemed as default. XML_ID - value external ID. Parameter is used only when updating already existing list item values. ID - value identifier. If specified, it's deemed as an update for existing list item value and not creation of a new one. Useful only when calling methods `.userfield.update`. DEL* - when set as Y, existing list item will be deleted. Applied when ID parameter is specified.

Example

var id = prompt("Enter ID");
var label = prompt("Enter new name");
BX24.callMethod(
	"crm.contact.userfield.update", 
	{ 
		id: id,
		fields: 
		{
			"EDIT_FORM_LABEL": label,
			"LIST_COLUMN_LABEL": label
		}
	}, 
	function(result) 
	{
		if(result.error())
			console.error(result.error());
		else
		{
			console.dir(result.data()); 			
			if(result.more())
				result.next();						
		}
	}
);