Actions20
Overview
This node allows managing custom user fields in Bitrix24 CRM entities such as Leads, Deals, Contacts, and Companies. It supports creating, updating, retrieving, listing, and deleting custom fields programmatically via Bitrix24's API.
Typical use cases include:
- Automating the addition of new custom fields to CRM entities to capture additional data.
- Updating existing custom field properties like labels or options without manual intervention.
- Retrieving details about specific custom fields for integration or reporting purposes.
- Cleaning up unused custom fields by deleting them automatically.
For example, a sales automation workflow could create a new enumeration-type custom field with predefined list values on a Lead entity to track lead sources more granularly.
Properties
| Name | Meaning |
|---|---|
| Field ID | The identifier of the custom user field (required for update, get, delete operations). |
| Field Label | The display name of the custom field shown in the UI (required for create and update). |
| List Values | For enumeration type fields: the list of selectable values. Each value is a string. |
| Multiple | Boolean indicating if the field allows multiple selections (true) or single selection (false). |
| Mandatory | Boolean indicating if the field is required (true) or optional (false). |
| Show Filter | Boolean indicating if the field should be available as a filter in lists (true/false). |
| Show In List | Boolean indicating if the field should be visible in list views (true/false). |
Output
The node outputs an array of JSON objects representing the results of the performed operations:
- For create and update operations, the output contains the API response confirming success or failure.
- For get, the output includes the detailed information of the requested custom field.
- For getAll, the output is a list of all custom fields for the selected resource.
- For delete, the output confirms whether the deletion was successful.
No binary data is produced by this node.
Dependencies
- Requires an active Bitrix24 API connection configured with a valid webhook URL and authentication credentials.
- Uses HTTP POST requests to Bitrix24 REST API endpoints corresponding to the selected resource and operation.
- Optionally sets the default language environment variable based on credential settings (defaults to Russian).
Troubleshooting
- Missing Credentials or Webhook URL: The node throws errors if no credentials or webhook URL are provided. Ensure proper API credentials and webhook URL are configured.
- API Errors: If Bitrix24 returns an error, the node surfaces the error description. Common issues include invalid field IDs, insufficient permissions, or malformed requests.
- Enumeration List Values: When updating or creating enumeration fields, ensure that list values are provided; otherwise, the API call may fail or ignore the list.
- Continue On Fail: If enabled, the node will continue processing remaining items even if some fail, returning error messages per item.