Bitrix24 User Field icon

Bitrix24 User Field

Работа с пользовательскими полями в Bitrix24

Overview

This node manages custom user fields in Bitrix24 CRM for various resources such as Deals, Leads, Contacts, and Companies. Specifically for the Deal resource with the Update operation, it updates an existing custom field's properties like label, multiplicity, mandatory status, visibility in filters and lists, and enumeration list values if applicable.

Common scenarios include:

  • Modifying the display name or label of a custom field on deals.
  • Changing whether a field allows multiple values or is mandatory.
  • Updating the list of selectable values for enumeration-type fields.
  • Adjusting visibility settings for filtering and listing in the Bitrix24 UI.

Practical example:
You have a custom dropdown field on deals representing deal stages, and you want to update its label and add new options to the dropdown list. This node lets you do that programmatically within your n8n workflow.

Properties

Name Meaning
Field ID The unique identifier of the custom field to update.
Field Label The display name (label) of the custom field shown in the Bitrix24 interface.
List Values For enumeration fields only: the list of possible values for the dropdown/select field.
Multiple Whether the field supports multiple values (true for multiple, false for single value).
Mandatory Whether the field is required (true) or optional (false).
Show Filter Whether to show this field as a filter option in Bitrix24 (true or false).
Show In List Whether to display this field in list views (true or false).

Output

The node outputs an array of JSON objects corresponding to the API responses from Bitrix24 for each input item processed. For the Update operation, the output typically contains the result of the update request, which may include success confirmation or error details.

Example output structure for a successful update:

{
  "result": true
}

If errors occur and "Continue On Fail" is enabled, the output may contain error messages per item:

{
  "error": "Error message describing what went wrong"
}

No binary data is produced by this node.

Dependencies

  • Requires an active Bitrix24 API authentication credential configured in n8n, providing a webhook URL and optionally a language setting.
  • Uses HTTP POST requests to Bitrix24 REST API endpoints specific to user field management.
  • Environment variable N8N_DEFAULT_LANGUAGE is set based on credential language or defaults to Russian ("ru").

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 configured.
  • API Errors: If Bitrix24 returns an error (e.g., invalid field ID, permission issues), the node surfaces the error description. Check the error message for guidance.
  • Incorrect Field ID: Providing an invalid or non-existent Field ID will cause the update to fail.
  • Invalid Enumeration Values: When updating enumeration fields, ensure the list values are correctly formatted; otherwise, the API may reject the request.
  • Language Setting: If the language is not set in credentials, the node defaults to Russian, which might affect error messages or labels.

To resolve errors:

  • Verify all required parameters are correctly set.
  • Confirm the Field ID exists in Bitrix24.
  • Check API permissions and webhook URL validity.
  • Use "Continue On Fail" cautiously to handle partial failures gracefully.

Links and References

Discussion