Change Field Visibility Settings rpa.fields.setVisibilitySettings
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
rpaWho can execute the method: any user
DEPRECATED
The development of this method has been halted. Use Smart scripts as an alternative to this functionality.
This method updates the visibility settings of fields for the process with the identifier typeId at the stage with the identifier stageId. Other settings remain unchanged.
The method should be used when you need to change the visibility settings for only one type.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
typeId* |
Identifier of the process |
|
visibility* |
Identifier of the visibility for which the settings are being changed |
|
stageId |
Identifier of the stage. Defaults to |
|
fields* |
Array of fields for which the settings need to be changed |
Code Examples
How to Use Examples in Documentation
try
{
const response = await $b24.callMethod(
'rpa.comment.add',
{
"typeId": 1,
"visibility": "kanban",
"fields": [
"createdBy",
"UF_RPA_1_NAME"
]
}
);
const result = response.getData().result;
console.log('response', result.answer);
if(result.error())
alert("Error: " + result.error());
else
console.log(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'rpa.comment.add',
[
'typeId' => 1,
'visibility' => 'kanban',
'fields' => [
'createdBy',
'UF_RPA_1_NAME',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your required data processing logic
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding comment: ' . $e->getMessage();
}
BX24.callMethod(
'rpa.comment.add',
{
"typeId": 1,
"visibility": "kanban",
"fields": [
"createdBy",
"UF_RPA_1_NAME"
]
},
function(result) {
console.log('response', result.answer);
if(result.error())
alert("Error: " + result.error());
else
console.log(result.data());
}
)
Response Handling
The method will return a result similar to the request rpa.fields.getSettings.
Continue Learning
- Field Visibility Settings: Overview of Methods
- Get the Complete Set of Field Visibility Settings rpa.fields.getSettings
- Set Full Visibility Settings for rpa.fields.setSettings