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 Company resource with the Create operation, it enables creating a new custom field for company records in Bitrix24.
Common scenarios include:
- Extending the default company data model with additional custom attributes.
- Automating the creation of custom fields during onboarding or integration setups.
- Dynamically adding fields based on business needs without manual intervention in Bitrix24 UI.
For example, you might create a custom field named UF_CRM_CUSTOM_FIELD of type "String" to store a unique internal code for companies, or an enumeration field to categorize companies by industry sectors.
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 for Enumeration type) The list of selectable values for the enumeration field. |
| 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 display this field in lists (true/false). |
Output
The node outputs an array of JSON objects representing the API response from Bitrix24 for each input item processed. For the create operation, the output typically includes:
- A success indicator.
- The ID of the newly created custom field.
- Any error messages if the creation failed.
Example output snippet:
{
"result": {
"ID": "123",
"FIELD_NAME": "UF_CRM_CUSTOM_FIELD",
...
},
"error": null
}
No binary data is produced by this node.
Dependencies
- Requires an active Bitrix24 API connection via a webhook URL credential.
- The webhook URL must have permissions to manage CRM user fields.
- The node uses HTTP POST requests to Bitrix24 REST API endpoints.
- Optionally sets the environment language variable based on credentials for localization.
Troubleshooting
- Missing Credentials or Webhook URL: The node will throw an error if no valid API credentials or webhook URL are provided. Ensure credentials are configured correctly.
- API Errors: If Bitrix24 returns an error (e.g., invalid field name, permission denied), the node surfaces the error message. Check the error description for details.
- Invalid Field Parameters: Providing unsupported field types or missing required properties like Field Name or Field Label will cause failures.
- Enumeration Values: When creating an enumeration field, ensure at least one list value is provided; otherwise, the API may reject the request.
- Continue On Fail: If enabled, errors for individual items are returned as error objects instead of stopping execution.