Actions20
Overview
This node allows users to manage custom user fields in Bitrix24 CRM entities such as Leads, Deals, Contacts, and Companies. It supports creating, updating, retrieving, listing, and deleting custom fields for these resources.
Typical use cases include:
- Adding new custom fields to capture additional data specific to your business needs.
- Updating existing custom fields to change labels, types, or options.
- Retrieving details of a particular custom field.
- Listing all custom fields available for a resource.
- Removing obsolete or unused custom fields.
For example, you might create a custom field "UF_CRM_CUSTOM_FIELD" of type "String" with a label "Customer Feedback" to store feedback notes on leads.
Properties
| Name | Meaning |
|---|---|
| Field Name | The internal name of the custom field (e.g., UF_CRM_CUSTOM_FIELD). Required for creation. |
| Field Label | The display name of the custom field shown in the UI. Required for creation and update. |
| Field Type | The data type of the custom field. Options: String, Integer, Double, Boolean, Enumeration, Date, DateTime, File, Money, URL. Required for creation. |
| List Values | For Enumeration type only: list of selectable values for the dropdown list. |
| 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). |
These properties are used when creating or updating a custom field.
Output
The node outputs JSON data representing the response from the Bitrix24 API for each input item processed:
- For Create operation: returns the API response confirming the creation of the user field.
- For Update operation: returns the API response confirming the update.
- For Get operation: returns the details of the requested user field.
- For Get All operation: returns an array of all user fields for the selected resource.
- For Delete operation: returns the API response confirming deletion.
No binary data output is produced by this node.
Dependencies
- Requires an active Bitrix24 account with API access.
- Needs a configured API authentication credential providing a webhook URL.
- Uses the Bitrix24 REST API endpoints via HTTP POST requests.
- The node sets the default language environment variable based on credentials or defaults to Russian ("ru").
Troubleshooting
- Missing Credentials or Webhook URL: The node throws errors if no credentials or webhook URL are provided. Ensure the API key and webhook URL are correctly configured.
- API Errors: If Bitrix24 API returns an error, the node surfaces the error description. Common issues include invalid field names, duplicate fields, or permission problems.
- Invalid Field Type or Missing List Values: When creating or updating enumeration fields, ensure that list values are provided; otherwise, the API call may fail.
- Continue On Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error messages in the output JSON.