Actions20
Lead → Create
AI-generatedOverview
This node allows users to create custom user fields for the Lead resource in Bitrix24 CRM. It is useful for extending the default data model by adding new fields with specific types and properties, such as mandatory status, multiple values, and visibility options. For example, a user can create a custom enumeration field to categorize leads or a date field to track a specific event related to a lead.
Use Case Examples
- Create a custom string field named 'UF_CRM_CUSTOM_FIELD' with a label 'Custom Field' for leads.
- Create an enumeration field with predefined list values to classify leads into different categories.
Properties
| Name | Meaning |
|---|---|
| Field Name | The internal identifier for the custom field (e.g., UF_CRM_CUSTOM_FIELD). Required for creating a field. |
| Field Label | The display label for the custom field shown in the UI. Required for creating a field. |
| Field Type | The data type of the custom field, such as string, integer, boolean, enumeration, date, datetime, file, money, or URL. Required for creating a field. |
| List Values | A collection of values used only if the field type is 'enumeration'. Defines the selectable options for the enumeration field. |
| Multiple | Indicates if the field can hold multiple values (true or false). |
| Mandatory | Indicates if the field is required (true or false). |
| Show Filter | Determines if the field should be available as a filter in the UI (true or false). |
| Show In List | Determines if the field should be visible in list views (true or false). |
Output
JSON
result- The response from Bitrix24 API after creating the user field, typically including the new field's ID and status.
Dependencies
- Bitrix24 API with appropriate credentials
Troubleshooting
- Ensure the Field Name is unique and follows Bitrix24 naming conventions to avoid API errors.
- If the field type is 'enumeration', provide at least one list value; otherwise, the API request may fail.
- Check that all required parameters (Field Name, Field Label, Field Type) are provided to prevent validation errors.
- Handle API errors gracefully, especially when the Bitrix24 API returns errors related to permissions or invalid data.
Links
- Bitrix24 User Fields API Documentation - Official documentation for managing user fields in Bitrix24 CRM.