Bitrix24 icon

Bitrix24

Work with Bitrix24 API

Overview

This node integrates with the Bitrix24 CRM system to manage Lead records. Specifically, the "Update" operation allows users to modify existing Lead entries by specifying the record ID and the fields to update. This is useful in scenarios where lead information changes over time, such as updating contact details, status, or custom fields after initial creation.

Practical examples include:

  • Updating a lead's phone number or email address when new contact information is received.
  • Changing the lead status based on recent interactions or sales progress.
  • Modifying custom fields like lead source or priority to reflect updated business insights.

The node supports two input formats for field data: form-based (structured fields) and JSON, providing flexibility depending on user preference or complexity of data.

Properties

Name Meaning
ID The unique identifier of the Lead record to update.
Input Format Method to provide fields for update:
- Form: Use structured fields input.
- JSON: Provide fields as a JSON object.
Fields (JSON) JSON-formatted fields representing the data to update (used if Input Format is JSON).
Fields Collection of fields to update when using Form input format. Each field includes:
- Field Name: The name of the Lead field to update.
- Field Value Type: For certain resources and fields, specifies communication type (e.g., Work, Mobile).
- Field Value: The value to set for the field. Can be a string or an enumeration value depending on the field type.

Output

The node outputs an array of JSON objects corresponding to the results of the update operations performed on each input item. Each object typically contains the response from the Bitrix24 API, which includes success confirmation and any updated record details.

If an error occurs during an update, the output for that item will contain an error property describing the issue.

No binary data output is produced by this node.

Dependencies

  • Requires an active Bitrix24 API connection configured with a valid webhook URL and authentication credentials.
  • Uses HTTP POST requests to Bitrix24 REST API endpoints constructed from the webhook URL.
  • The node expects the webhook URL to be provided via credentials configuration.
  • Environment variable N8N_DEFAULT_LANGUAGE may be set dynamically based on credential language settings to influence localization.

Troubleshooting

  • Missing Credentials or Webhook URL: The node throws errors if no credentials are found or if the webhook URL is missing. Ensure the Bitrix24 API credentials are properly configured with a valid webhook URL.
  • Invalid Field Names or Values: If fields specified do not exist or have invalid values, the Bitrix24 API may reject the request. Verify field names against Bitrix24 CRM schema and use the node's dynamic field loading feature to select valid fields.
  • JSON Parsing Errors: When using JSON input format, malformed JSON will cause parsing failures. Validate JSON syntax before execution.
  • API Errors: Network issues or Bitrix24 API errors will be surfaced in the node output under the error property. Check API limits, permissions, and network connectivity.
  • Continue On Fail Behavior: If enabled, the node continues processing subsequent items even if some fail, collecting errors in the output.

Links and References

Discussion