userfieldtype.update

Modifies settings of user field types, registered by the application. This method returns true or an error with description.

Parameters

Parameter	Type	Description	Limitations
USER_TYPE_ID	String	Inline code of the type. Required parameter.	a-z0-9
HANDLER	URL	Address of user type handler. Required parameter.	Shall be in the same domain as the main application address.
TITLE	String	Type text name. Will be displayed in the admin interface of user field settings. Required parameter.
DESCRIPTION	String	Type text description. Will be displayed in the admin interface of user field settings.

Example

Call example

BX24.callMethod(
   'userfieldtype.update', 
   {
      USER_TYPE_ID: 'test',
      TITLE: 'Updated test type',
      DESCRIPTION: 'Test userfield type for documentation with updated description'
   }
);

Request example

POST https://sometestportal.bitrix24.com/rest/userfieldtype.update HTTP/1.1

USER_TYPE_ID=test&TITLE=Updated+test+type&DESCRIPTION=Test+userfield+type+for+documentation+with+updated+description&auth=63t6r4z9cugaciaxocrh2r47zlodp12y

HTTP/1.1 200 OK

{
    "result": true
}