Actions20
Contact → Create
AI-generatedOverview
This node allows users to create custom user fields for the Contact resource in Bitrix24 CRM. It is useful for extending the default contact data model with additional fields tailored to specific business needs, such as custom text fields, enumerations, dates, or files. For example, a user can create a custom field to track a contact's preferred communication method or membership status.
Use Case Examples
- Create a custom text field named 'Preferred Language' to store the contact's language preference.
- Create an enumeration field to categorize contacts by membership level with predefined values like 'Gold', 'Silver', and 'Bronze'.
Properties
| Name | Meaning |
|---|---|
| Field Name | The internal identifier for the custom field (e.g., UF_CRM_CUSTOM_FIELD). This is required to uniquely identify the field in Bitrix24. |
| Field Label | The display label for the custom field shown in the Bitrix24 UI. |
| Field Type | The data type of the custom field, such as string, integer, boolean, enumeration, date, datetime, file, money, or URL. |
| List Values | A list of predefined values for enumeration type fields. Each value represents an option in the dropdown list. |
| Multiple | Indicates if the field supports 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 (e.g., starts with UF_CRM_).
- Verify that the Field Type matches the expected data format and that enumeration fields have valid list values.
- Check API credentials and permissions to confirm the user has rights to create custom fields in Bitrix24.
- Common errors include invalid field names, missing required parameters, or API authentication failures. Review error messages for specific details and correct input accordingly.
Links
- Bitrix24 CRM User Fields API Documentation - Official Bitrix24 documentation on managing custom user fields via API.