Actions20
Overview
This node allows you to manage custom user fields in Bitrix24 CRM entities such as Leads, Deals, Contacts, and Companies. Specifically for the Lead resource with the Create operation, it enables creating a new custom field in the Lead entity.
Common scenarios where this node is useful include:
- Extending the default Lead data model by adding custom fields tailored to your business needs.
- Automating the creation of custom fields during onboarding or integration processes.
- Dynamically managing CRM schema without manual intervention in the Bitrix24 UI.
For example, you can create a custom field named "UF_CRM_CUSTOM_FIELD" of type "String" with a label "Custom Field" that appears in filters and lists, and mark it as mandatory if needed.
Properties
| Name | Meaning |
|---|---|
| Field Name | The internal name of the custom field (e.g., UF_CRM_CUSTOM_FIELD). Required. |
| Field Label | The display label of the custom field shown in forms and lists. Required. |
| Field Type | The data type of the custom field. Options: String, Integer, Double, Boolean, Enumeration, Date, Datetime, File, Money, URL. Required. |
| List Values | (Only for Enumeration type) The list of selectable values for the enumeration field. Multiple values can be added and sorted. |
| Multiple | Whether the field supports multiple values (true/false). |
| Mandatory | Whether the field is required (true/false). |
| Show Filter | Whether to show the field in filter options (true/false). |
| Show In List | Whether to show the field in list views (true/false). |
Output
The node outputs an array of JSON objects representing the API response(s) from Bitrix24 after attempting to create the user field(s).
- For successful creation, the output contains the Bitrix24 API response confirming the new field.
- If multiple items are processed, each result is included in the output array.
- In case of errors (if continue on fail is enabled), error messages are included in the output objects.
No binary data is produced by this node.
Dependencies
- Requires an active connection to Bitrix24 via a webhook URL credential that provides authentication.
- Uses the Bitrix24 REST API endpoints for user field management.
- Requires proper permissions in Bitrix24 to create custom fields on the Lead entity.
Troubleshooting
- Missing Credentials or Webhook URL: The node will throw an error if no credentials or webhook URL are provided. Ensure the API key or webhook URL is correctly configured.
- 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:".
- Invalid Field Name: The field name must follow Bitrix24 naming conventions (usually starting with "UF_CRM_"). Using invalid names may cause API errors.
- Enumeration Values Missing: When creating an enumeration type field, ensure at least one list value is provided; otherwise, the API call may fail.
- Continue On Fail: If enabled, the node continues processing other items even if some fail, returning error details in the output.