Bitrix24 User Field

Overview

This node manages custom user fields in Bitrix24 CRM for various resources such as Leads, Deals, Contacts, and Companies. Specifically, the Update Contact User Field operation allows updating an existing custom field of a Contact resource by modifying its label, visibility, mandatory status, multiplicity, and list values (for enumeration types).

Common scenarios where this node is useful include:

• Renaming or relabeling a custom contact field to better reflect business terminology.
• Changing whether a field is mandatory or optional based on updated data requirements.
• Adjusting if a field supports multiple values or single value.
• Updating dropdown list options for enumeration-type fields.
• Controlling whether the field appears in filters or lists within Bitrix24 UI.

Practical example:
A marketing team wants to update the label of a custom "Customer Segment" field on contacts and add new options to its dropdown list without recreating the field from scratch. This node can perform that update seamlessly.

Properties

Output

The node outputs an array of JSON objects representing the API responses from Bitrix24 for each processed item. For the Update operation, the output typically contains confirmation of the update action with details about the updated field or error information if the update failed.

Example output structure for a successful update might look like:

{
  "result": {
    "id": "123",
    "field": {
      "EDIT_FORM_LABEL": "New Label",
      "MULTIPLE": "N",
      "MANDATORY": "Y",
      ...
    }
  }
}

If errors occur, the output includes an error property with the error message.

Dependencies

• Requires an active Bitrix24 API connection via a webhook URL credential.
• Uses HTTP POST requests to Bitrix24 REST API endpoints specific to CRM user fields.
• Requires proper permissions in Bitrix24 to update user fields.
• The node expects the webhook URL to be configured in credentials.
• Optionally sets environment language variable based on credential configuration.

Troubleshooting

• Missing Credentials or Webhook URL:
  Error: "No credentials got returned!" or "Webhook URL is required!"
  Resolution: Ensure the Bitrix24 API credential is properly set up with a valid webhook URL.

• API Errors from Bitrix24:
  Errors returned from Bitrix24 API are surfaced with messages like "Bitrix24 API error: ".
  Resolution: Check the error description for issues such as invalid field ID, insufficient permissions, or malformed request data.

• Invalid Field ID:
  If the specified Field ID does not exist or is incorrect, the update will fail.
  Resolution: Verify the Field ID corresponds to an existing custom field in Bitrix24.

• Incorrect List Values Format:
  For enumeration fields, the list values must be provided correctly; otherwise, the update may ignore them or fail.
  Resolution: Provide list values as an array of objects with value strings.

• Continue On Fail Behavior:
  If enabled, the node collects errors per item instead of stopping execution, allowing partial success.

Links and References

• Bitrix24 REST API Documentation - User Fields
• Bitrix24 Custom Fields Management
• n8n Documentation - Creating Custom Nodes