bx24_crm_leads
Manage Bitrix24 CRM leads with full CRUD operations, contact binding, custom fields, product rows, conversion to deals, and card configuration.
Instructions
Bitrix24 CRM leads: CRUD, fields, contacts, user fields. Methods crm.lead.* (REST 1.0 + 3.0). RU/EN: лид, новый лид, создать лид, найди лиды, обнови лид, удали лид / lead, create lead, find leads, update lead, delete lead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Entity ID | |
| rows | No | Product row array: {PRODUCT_ID, PRICE, QUANTITY, ...} | |
| order | No | Order object (e.g. { 'ID': 'DESC' }) | |
| start | No | Pagination offset (number of records to skip) | |
| action | Yes | Operation to perform: - "add": Create a lead (TITLE required) - "get": Get a lead by ID - "list": List/filter leads - "update": Update lead fields by ID - "delete": Delete a lead (destructive) - "fields": Describe all lead fields — call first when unsure - "contact_get": List contacts bound to a lead - "contact_add": Bind a contact to a lead - "contact_delete": Unbind a contact (destructive) - "contact_items_set": Set the full set of contacts on a lead - "contact_items_delete": Clear all contacts from a lead (destructive) - "userfield_get": Get a custom lead field - "userfield_add": Create a custom lead field - "userfield_update": Update a custom lead field - "userfield_delete": Delete a custom lead field (destructive) - "convert": Convert a lead to a deal/contact - "productrows_get": Get lead product rows - "productrows_set": Overwrite lead product rows (destructive — full rewrite) - "details_get": Get lead card configuration (layout) - "details_set": Set lead card configuration - "details_reset": Reset lead card configuration to default | |
| fields | No | Lead fields: TITLE (required), NAME, LAST_NAME, PHONE[], EMAIL[], COMPANY_TITLE, STATUS_ID, SOURCE_ID, ASSIGNED_BY_ID. Use action=fields for the full list. | |
| filter | No | Filter object (e.g. { '>OPPORTUNITY': 10000, 'STAGE_ID': 'WON' }) | |
| select | No | Array of field names to return (projection) | |
| confirm | No | Set to true to confirm destructive actions when BX24_CONFIRM_DESTRUCTIVE is enabled. | |
| contactId | No | Contact ID bound to the lead | |
| userfield | No | User field definition: FIELD_NAME, USER_TYPE_ID, LABEL, ... | |
| contactIds | No | Contact IDs to set | |
| userfieldId | No | CRM userfield ID (e.g. UF_CRM_123) | |
| configFields | No | Lead card configuration (details.configuration.*) fields |