Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform

Actions290

Overview

This node allows users to delete a User Field Configuration in Bitrix24 CRM. User Field Configurations define custom fields for various CRM entities such as Deals, Leads, Contacts, or Smart Processes. Deleting a user field configuration removes the custom field definition from the specified entity.

Common scenarios include:

  • Cleaning up obsolete or unused custom fields from CRM entities.
  • Automating the management of CRM schema by removing fields no longer needed.
  • Integrating with workflows that dynamically adjust CRM data structures.

Example: A sales automation workflow detects that a custom "Customer Feedback" field is no longer relevant and deletes it from the Deal entity automatically.

Properties

Name Meaning
Authentication Method of authenticating with Bitrix24 API. Options: OAuth2 (recommended), Webhook (simpler), API Key.
ID The unique identifier of the user field configuration to delete.
Entity ID The target entity's ID where the user field config exists. Examples: DEAL, LEAD, CONTACT, or CRM_[ID] for Smart Process.
Options Additional options collection. Contains: Access Token (string) for authentication purposes.

Output

The node outputs JSON data representing the result of the deletion operation. Typically, this will confirm success or provide error details if the deletion failed.

If an error occurs and the node is configured to continue on failure, the output JSON includes:

  • error: The error message string.
  • resource: The resource name ("userFieldConfig").
  • timestamp: ISO timestamp of when the error occurred.

No binary data output is produced by this node.

Dependencies

  • Requires connection to Bitrix24 CRM via one of the supported authentication methods (OAuth2, webhook URL, or API key).
  • Needs appropriate permissions in Bitrix24 to delete user field configurations.
  • No additional external services beyond Bitrix24 API are required.

Troubleshooting

  • Common issues:

    • Invalid or missing ID or Entity ID parameters will cause the API call to fail.
    • Insufficient permissions in Bitrix24 to delete user fields.
    • Incorrect authentication setup leading to authorization errors.
    • Network connectivity issues preventing API calls.
  • Error messages:

    • "Failed to load fields" or similar indicates problems fetching necessary metadata before deletion.
    • Authorization errors suggest checking API credentials and scopes.
    • If the node throws an error but is set to continue on fail, the error details appear in the output JSON under the error property.
  • Resolutions:

    • Verify the correctness of the ID and Entity ID values.
    • Ensure the API credentials have delete permissions.
    • Confirm network access to Bitrix24 endpoints.
    • Use OAuth2 authentication for production environments for better security and reliability.

Links and References

Discussion