Bitrix24 User Field icon

Bitrix24 User Field

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

Overview

This node interacts with Bitrix24 to manage custom user fields for CRM entities such as Leads, Deals, Contacts, and Companies. It supports operations to create, update, retrieve (get), list all, and delete user fields associated with these resources.

Common scenarios include:

  • Adding new custom fields to CRM entities to capture additional data.
  • Updating existing custom fields to change labels or properties.
  • Retrieving details of a specific custom field by its ID.
  • Listing all custom fields available for a resource.
  • Deleting obsolete or unused custom fields.

Practical example: A sales team wants to add a custom dropdown field to Leads to track the lead source more precisely. They can use this node to create that field with enumeration options, then later update or remove it as needed.

Properties

Name Meaning
Field ID The unique identifier of the custom user field (required for get, update, and delete).

Output

The node outputs JSON data representing the response from the Bitrix24 API for each operation:

  • Get: Returns the details of the specified user field, including its configuration and metadata.
  • Create: Returns the result of creating a new user field, typically including the new field's ID.
  • Update: Returns the result of updating an existing user field.
  • Get All: Returns an array of all user fields for the selected resource.
  • Delete: Returns the result of deleting the specified user field.

No binary data output is produced by this node.

Dependencies

  • Requires an active Bitrix24 API credential with a valid webhook URL.
  • Uses HTTP POST requests to Bitrix24 webhook endpoints corresponding to the selected resource and operation.
  • Optionally sets the default language environment variable based on credential settings (defaults to Russian if not set).

Troubleshooting

  • Missing Credentials or Webhook URL: The node will throw an error if no credentials are provided or if the webhook URL is missing. Ensure proper API authentication is configured.
  • API Errors: If Bitrix24 returns an error, the node surfaces the error description. Common causes include invalid field IDs, insufficient permissions, or malformed requests.
  • Continue On Fail: When enabled, the node captures errors per item and continues processing others, returning error messages in the output JSON.
  • Field ID Required: For "get", "update", and "delete" operations, the Field ID must be provided; otherwise, the node will fail.

Links and References

Discussion