Actions20
Overview
This node manages custom user fields for the "Lead" resource in Bitrix24 CRM. Specifically, the Update operation allows you to modify an existing custom field of a Lead by changing its label, visibility, mandatory status, and list values if it is an enumeration type.
Common scenarios where this node is useful include:
- Renaming or relabeling a custom field after initial creation.
- Changing whether a field is mandatory or optional.
- Adjusting if the field appears in filters or lists within Bitrix24.
- Updating the selectable options of an enumeration (dropdown) field.
For example, if your sales team wants to rename a lead qualification field from "Interest Level" to "Priority Level" and add new dropdown options, this node can perform that update programmatically.
Properties
| Name | Meaning |
|---|---|
| Field ID | The unique identifier of the custom user field to update. |
| Field Label | The display name (label) of the field shown in forms and lists. |
| List Values | For enumeration fields only: the list of selectable values for the dropdown. |
| Multiple | Whether the field supports multiple selections (true/false). |
| Mandatory | Whether the field is required to be filled (true/false). |
| Show Filter | Whether to show this field as a filter option in Bitrix24 UI (true/false). |
| Show In List | Whether to display this field in list views inside Bitrix24 (true/false). |
Output
The node outputs an array of JSON objects representing the API responses from Bitrix24 for each input item processed. For the Update operation, the output typically contains confirmation data about the updated field or error information if the update failed.
Example output structure for a successful update might look like:
{
"result": true,
"fieldId": "123"
}
If an error occurs during the update, the output will contain an error message object:
{
"error": "Error message describing what went wrong"
}
No binary data is produced by this node.
Dependencies
- Requires an active Bitrix24 API connection configured with a valid webhook URL.
- The webhook URL must have permissions to manage CRM user fields.
- The node uses HTTP POST requests via Axios to communicate with Bitrix24 REST API endpoints.
- Optionally sets the default language environment variable based on credentials for localization.
Troubleshooting
- Missing Credentials or Webhook URL: The node throws an error if no credentials or webhook URL are provided. Ensure the Bitrix24 API credential is properly set up.
- Invalid Field ID: If the specified Field ID does not exist or is incorrect, the API will return an error. Verify the Field ID before updating.
- Incorrect Enumeration Values: When updating enumeration fields, ensure the list values are correctly formatted; otherwise, the update may fail.
- API Errors: Any Bitrix24 API errors are caught and reported with descriptive messages. Check the error description for guidance.
- Continue On Fail: If enabled, the node continues processing other items even if one fails, returning error details in the output.