Actions20
Lead → Update
AI-generatedOverview
This node updates a user field for the Lead resource in Bitrix24 CRM. It allows modifying properties of a custom field such as its label, whether it supports multiple values, if it is mandatory, and visibility options like showing in filters or lists. For enumeration type fields, it also supports updating the list of possible values. This node is useful for managing and customizing lead data fields dynamically within Bitrix24, for example, updating a lead's custom dropdown field options or changing the label of a field to better reflect business needs.
Use Case Examples
- Updating the label of a lead's custom field to a new descriptive name.
- Changing a lead field to allow multiple selections instead of a single value.
- Updating the list of values for an enumeration type lead field to reflect new options.
Properties
| Name | Meaning |
|---|---|
| Field ID | The unique identifier of the user field to update. Required to specify which field to modify. |
| Field Label | The new label for the user field, which appears in forms and lists. |
| List Values | For enumeration type fields, the updated list of selectable values. Each value includes a string representing the option. |
| Multiple | Boolean flag indicating if the field supports multiple values (true) or a single value (false). |
| Mandatory | Boolean flag indicating if the field is required (true) or optional (false). |
| Show Filter | Boolean flag to show or hide the field in filter options (true to show). |
| Show In List | Boolean flag to show or hide the field in list views (true to show). |
Output
JSON
id- The ID of the updated user field.result- The result status of the update operation, typically a boolean indicating success.
Dependencies
- Bitrix24 API with appropriate authentication credentials
Troubleshooting
- Ensure the Field ID provided exists and is correct; otherwise, the update will fail.
- For enumeration fields, ensure the list values are provided correctly as an array of objects with 'value' properties.
- Check API credentials and permissions to confirm the user has rights to update user fields in Bitrix24.
- Common error messages include invalid field ID, insufficient permissions, or malformed request data. Verify all required parameters are set and valid.
Links
- Bitrix24 CRM Lead User Field Update API - Official Bitrix24 documentation for updating user fields on leads via API.