Bitrix24 icon

Bitrix24

Work with Bitrix24 API

Overview

This node integrates with the Bitrix24 CRM system, allowing users to perform various operations on CRM records such as leads, deals, contacts, and companies. Specifically, the Update operation enables updating an existing record by its ID with new field values.

Common scenarios for using this node include:

  • Automatically updating contact information when a customer submits a form.
  • Modifying deal details based on changes in external systems.
  • Synchronizing updated company data from other databases or services.

For example, you might use this node to update a contact's phone number or email address after receiving new information from a customer support ticket.

Properties

Name Meaning
ID The unique identifier of the record to update. Required for update and delete operations.
Input Format Method to provide fields for update:
- Form: Enter fields individually.
- JSON: Provide all fields as a JSON object.
Fields (JSON) When using JSON input format, specify the fields and their values as a JSON object.
Fields When using Form input format, add one or more fields to update:
- Field Name: The name of the field to update.
- Communication Type (only for certain contact fields): Type of contact data like Work, Mobile, Home, Fax, Telegram, WhatsApp, Viber, Facebook, Skype, Other.
- Field Value: The value to set for the field. For enumeration-type fields, select from available options; otherwise, enter a string.

Output

The node outputs an array of JSON objects representing the response from the Bitrix24 API for each input item processed. For the Update operation, the output typically contains the result of the update request, which may include success confirmation or error details.

Example output structure for an update:

[
  {
    "result": {
      "ID": "123",
      "fields": {
        "NAME": "Updated Name",
        "PHONE": [{"VALUE": "+1234567890", "VALUE_TYPE": "WORK"}]
      }
    }
  }
]

If an error occurs during processing, the output will contain an error property describing the issue.

The node does not output binary data.

Dependencies

  • Requires a valid Bitrix24 API webhook URL credential configured in n8n.
  • Uses HTTP POST requests to Bitrix24 REST API endpoints.
  • The webhook URL must have permissions to update the specified resource type.
  • Optionally supports setting a language preference via credentials, affecting error messages and labels.

Troubleshooting

  • Missing Credentials or Webhook URL: The node throws errors if no credentials or webhook URL are provided. Ensure the API key/credential is correctly set up.
  • Invalid Field Names or Values: If fields do not exist or values are invalid (e.g., wrong enumeration), the API may return errors. Use the "Fields" dropdown or load options to select valid fields.
  • JSON Parsing Errors: When using JSON input format, ensure the JSON is well-formed; otherwise, parsing will fail.
  • API Response Errors: Network issues or permission problems can cause API call failures. Check connectivity and access rights.
  • Continue On Fail: If enabled, the node continues processing remaining items even if some fail, returning error details per item.

Links and References

Discussion