Bitrix24 icon

Bitrix24

Work with Bitrix24 API

Overview

This node integrates with the Bitrix24 CRM system to manage Contact records, specifically supporting the update operation for Contacts. It allows users to update existing contact records by specifying the record ID and the fields to modify. The node supports two input formats for field data: a structured form-based input or raw JSON.

Common scenarios where this node is beneficial include:

  • Automating updates to contact information such as phone numbers, emails, or custom fields based on external triggers.
  • Synchronizing contact data from other systems into Bitrix24.
  • Bulk updating contacts in workflows where multiple records need modification.

For example, you could use this node to update a contact's mobile phone number and email address when a customer submits a form on your website, ensuring your CRM always has the latest info.

Properties

Name Meaning
ID The unique identifier of the contact record to update. This is required to specify which contact to modify.
Input Format The format used to provide the fields for update. Options are:
- Form: Use a structured form interface to specify each field.
- JSON: Provide all fields as a JSON object string.
Fields (JSON) When using JSON input format, this property accepts a JSON string representing the fields and their new values to update in the contact record.
Fields When using Form input format, this is a collection of fields to update. Each entry includes:
- Field Name: The name of the contact field to update.
- Communication Type (for certain fields): e.g., Work, Mobile, Home, Fax, Telegram, WhatsApp, Viber, Facebook, Skype, Other.
- Field Value: The new value for the field. For enumeration-type fields, selectable options are loaded dynamically based on the field.

Output

The node outputs an array of JSON objects representing the response from the Bitrix24 API for each processed item. For the update operation, the output typically contains the result of the update request, including success status and any updated record details returned by Bitrix24.

The json output structure generally looks like:

{
  "result": {
    "ID": "123",
    // other updated fields as returned by Bitrix24
  }
}

No binary data output is produced by this node.

Dependencies

  • Requires a valid Bitrix24 API authentication token configured in n8n credentials.
  • Needs the Bitrix24 webhook URL to access the CRM API endpoints.
  • Uses the Bitrix24 REST API endpoints for contacts, specifically URLs like {webhookUrl}crm.contact.update.json.
  • Relies on axios HTTP client for making API requests.

Troubleshooting

  • Missing Credentials or Webhook URL: The node will throw errors if the API credentials or webhook URL are not set or invalid. Ensure that the Bitrix24 API credential is properly configured with a valid webhook URL.
  • Invalid JSON in Fields (JSON): If using JSON input format, malformed JSON will cause parsing errors. Validate JSON syntax before running the node.
  • Field Names Not Found: If a specified field name does not exist in Bitrix24, the update may fail or ignore that field. Use the dynamic field loader to select valid fields.
  • API Errors: Network issues or permission problems in Bitrix24 can cause API call failures. Check API permissions and network connectivity.
  • Continue On Fail Behavior: If enabled, the node will continue processing remaining items even if some fail, returning error messages per failed item.

Links and References

Discussion