Update Custom Field task.item.userfield.update

Scope: task

Who can execute the method: administrator

The method task.item.userfield.update updates the parameters of a task's custom field.

Method Parameters

Required parameters are marked with *

Name
type

Description

ID*
integer

Identifier of the custom field.

The identifier of the task's custom field can be obtained when creating the field or by using the method to get the list of fields

DATA*
object

Set of parameters to be updated for the field (detailed description)

DATA Parameter

Name `type`	Description
XML_ID `string`	External identifier
EDIT_FORM_LABEL `object`	Label in the edit form (detailed description)
LABEL `string`	Name of the custom field
SORT `integer`	Sorting
MULTIPLE `string`	Multiple value. Possible values: `Y` — multiple `N` — single Applicable for types `string`, `double`, `datetime`. For the `boolean` type, `N` is always used
MANDATORY `string`	Mandatory value. Possible values: `Y` — mandatory `N` — optional
SETTINGS `object`	Additional settings for the field type (detailed description)

EDIT_FORM_LABEL Parameter

Name `type`	Description
en `string`	Label in English

SETTINGS Parameter

The fields of the SETTINGS object depend on the USER_TYPE_ID type.

string

double

datetime

boolean

Name `type`	Description
DEFAULT_VALUE `string`	Default value
ROWS `integer`	Number of rows in the input field

Name `type`	Description
DEFAULT_VALUE `double`	Default value

Name
type

Description

DEFAULT_VALUE

Default value. Described as an object with two parameters:

TYPE string — mode for setting the default value
- NONE — no default value set
- FIXED — uses the value from VALUE
- NOW — uses the current time
VALUE datetime — value for the FIXED type

DEFAULT_VALUE: {
            TYPE: 'NOW',
            VALUE: ''
        },

Name
type

Description

DEFAULT_VALUE
integer

Default value:

0 — no
1 — yes

DISPLAY
string

Display option for the value:

CHECKBOX — checkbox
RADIO — radio buttons
DROPDOWN — dropdown list

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
          "ID": 1325,
          "DATA": {
            "EDIT_FORM_LABEL": {
              "en": "Description of client request"
            },
            "MANDATORY": "N"
          }
        }' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.item.userfield.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
          "ID": 1325,
          "DATA": {
            "EDIT_FORM_LABEL": {
              "en": "Description of client request"
            },
            "MANDATORY": "N"
          },
          "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/task.item.userfield.update

try
        {
            const response = await $b24.callMethod(
                'task.item.userfield.update',
                {
                    ID: 1325,
                    DATA: {
                        EDIT_FORM_LABEL: {
                            en: 'Description of client request'
                        },
                        MANDATORY: 'N'
                    }
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'task.item.userfield.update',
                    [
                        'ID' => 1325,
                        'DATA' => [
                            'EDIT_FORM_LABEL' => [
                                'en' => 'Description of client request'
                            ],
                            'MANDATORY' => 'N',
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'task.item.userfield.update',
            {
                ID: 1325,
                DATA: {
                    EDIT_FORM_LABEL: {
                        en: 'Description of client request'
                    },
                    MANDATORY: 'N'
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'task.item.userfield.update',
            [
                'ID' => 1325,
                'DATA' => [
                    'EDIT_FORM_LABEL' => [
                        'en' => 'Description of client request'
                    ],
                    'MANDATORY' => 'N',
                ]
            ]
        );
        
        print_r($result);

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1740000000.000000,
                "finish": 1740000000.100000,
                "duration": 0.100000,
                "processing": 0.080000,
                "date_start": "2025-02-20T10:00:00+01:00",
                "date_finish": "2025-02-20T10:00:00+01:00",
                "operating_reset_at": 1740003600,
                "operating": 0.080000
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Returns `true` if the field was successfully updated
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "ERROR_CORE",
            "error_description": "ID is not defined or invalid."
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Status	Code	Description	Value
`400`	`ERROR_CORE`	TASKS_ERROR_EXCEPTION_#0; Invalid arguments for Bitrix\Tasks\Integration\Rest\Task\UserField::update; 0/TE	Required parameters `ID` and `DATA` are not provided
`400`	`ERROR_CORE`	ID is not defined or invalid	A non-numeric value or a value `<= 0` was passed to the `ID` parameter
`400`	`ERROR_NOT_FOUND`	The entity with ID '{ID}' is not found	The custom field with the specified `ID` was not found
`400`	`ERROR_CORE`	Access denied	Insufficient permissions to modify the custom field

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Add Custom Field

Get Custom Field by ID

Update Custom Field task.item.userfield.update

Method ParametersMethod Parameters

DATA ParameterDATA Parameter

EDIT_FORM_LABEL ParameterEDIT_FORM_LABEL Parameter

SETTINGS ParameterSETTINGS Parameter

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

DATA Parameter

EDIT_FORM_LABEL Parameter

SETTINGS Parameter

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning