Bitrix24 icon

Bitrix24

袪邪斜芯褌邪 褋 Bitrix24 API

袥懈写 → 袩芯谢褍褔懈褌褜

AI-generated

Overview

This node interacts with the Bitrix24 API to perform operations on the 'Lead' resource. It supports creating, retrieving, listing, updating, and deleting lead records within Bitrix24. Common scenarios include managing sales leads by adding new leads, fetching lead details by ID or filter, listing multiple leads with optional filters, updating lead information, and deleting leads.

Use Case Examples

  1. Create a new lead with specific fields such as name and contact information.
  2. Retrieve a lead by its unique ID to view detailed information.
  3. List all leads that meet certain filter criteria, such as leads from a specific source.
  4. Update an existing lead's status or contact details based on its ID or filter conditions.

Properties

Name Meaning
getBy Method to retrieve a lead record, either by ID or by applying a filter.
id The unique identifier of the lead record to get, update, or delete.
filterFields A collection of filter criteria to find leads based on field values and operations such as equals, not equals, greater than, contains, etc.
selectFields Specific lead fields to select and return in the response when getting or listing leads.

Output

JSON

  • ID - Unique identifier of the lead.
  • TITLE - Title or name of the lead.
  • STATUS_ID - Current status identifier of the lead.
  • CONTACT_ID - Identifier of the associated contact.
  • COMPANY_ID - Identifier of the associated company.
  • ASSIGNED_BY_ID - Identifier of the user assigned to the lead.
  • DATE_CREATE - Date and time when the lead was created.
  • DATE_MODIFY - Date and time when the lead was last modified.
  • ADDRESS - Address information of the lead.
  • PHONE - Phone number associated with the lead.
  • EMAIL - Email address associated with the lead.

Dependencies

  • Bitrix24 API access with appropriate credentials

Troubleshooting

  • Ensure the Bitrix24 API credentials are correctly configured and have sufficient permissions to access lead data.
  • When using filters, verify that the field names and operations are valid and supported by Bitrix24.
  • If retrieving by ID, confirm that the ID exists and is correctly formatted as a string or number.
  • Handle API rate limits by implementing retries or delays if necessary.

Links

Discussion