update_custom_property

The update_custom_property function is used to create a custom property for an item or to update an existing one.

Copied!
svc=item/update_custom_property&params={"itemId":<long>,
										"name":"<text>",
				 						"value":"<text>"}

To delete a custom property, use the same function but with an empty value parameter:

Copied!
svc=item/update_custom_property&params={"itemId":<long>,
										"name":"<text>",
				 						"value":""}

Parameters

NameDescription
itemIdItem ID.
nameCustom property name.
valueCustom property value.

Returned result

Copied!
{
	"n":"<text>",	/* custom property name */
	"v":"<text>"	/* custom property value */
}

Possible error codes:

NameDescription
7Failed to fetch the item with the desired ACL (ADF_ACL_ITEM_EDIT_OTHER).
6Undefined error.
4Wrong input parameters.
Download PDF file
Download Word document

See also