Bitrix24 User Field icon

Bitrix24 User Field

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

Overview

This node allows users to manage custom user fields in Bitrix24 CRM entities such as Leads, Deals, Contacts, and Companies. Specifically for the Contact resource with the Create operation, it enables creating a new custom field for contacts in Bitrix24.

Common scenarios include:

  • Extending the default contact data model by adding custom fields tailored to specific business needs.
  • Automating the creation of custom fields during onboarding or integration workflows.
  • Dynamically managing CRM schema without manual intervention in the Bitrix24 UI.

For example, you might create a custom field named UF_CRM_CUSTOM_FIELD of type "String" to store additional notes about a contact, or an enumeration field to categorize contacts by customer type.

Properties

Name Meaning
Field Name The internal identifier of the custom field (e.g., UF_CRM_CUSTOM_FIELD).
Field Label The display name of the custom field shown in the Bitrix24 interface.
Field Type The data type of the custom field. Options: String, Integer, Double, Boolean, Enumeration, Date, Datetime, File, Money, URL.
List Values (Only if Field Type is Enumeration) The list of selectable values for the enumeration field. Each value is a string.
Multiple Whether the field supports multiple values (true/false).
Mandatory Whether the field is required (true/false).
Show Filter Whether to show this field in filters (true/false).
Show In List Whether to show this field in lists (true/false).

Output

The node outputs an array of JSON objects representing the API response(s) from Bitrix24 for each input item processed.

For the Create operation on Contact user fields, the output JSON typically contains:

  • A success indicator and the ID of the newly created custom field.
  • Any error messages if the creation failed.

No binary data is produced by this node.

Dependencies

  • Requires an active Bitrix24 API authentication credential configured in n8n that provides a webhook URL.
  • Uses the Bitrix24 REST API endpoints via HTTP POST requests to manage user fields.
  • The webhook URL must be valid and accessible for API calls to succeed.

Troubleshooting

  • Missing Credentials or Webhook URL: The node throws errors if credentials are missing or the webhook URL is not provided. Ensure proper API credentials are set up.
  • API Errors: If Bitrix24 returns an error (e.g., invalid field name, permission denied), the node surfaces the error message prefixed with "Bitrix24 API error". Check the error description for details.
  • Invalid Field Type or Values: When creating an enumeration field, ensure at least one list value is provided; otherwise, the API call may fail.
  • Continue On Fail: If enabled, the node will continue processing subsequent items even if some fail, returning error details in the output JSON.

Links and References

Discussion