bx24_crm_deals
Create, retrieve, update, and delete Bitrix24 CRM deals, move deals through pipeline stages, and manage product rows, contact bindings, and recurring deal templates.
Instructions
Bitrix24 CRM deals: CRUD, funnels/categories, product rows, contact bindings, timeline. Methods crm.deal., crm.dealcategory., crm.deal.productrows., crm.deal.contact. (REST 1.0 + 3.0). RU/EN: сделка, создать сделку, найди сделки, передвинуть по воронке, закрыть сделку, товарные позиции / deal, create deal, find deals, move stage, close deal, product rows.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Entity ID | |
| row | No | Single product row | |
| 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 deal (TITLE required) - "get": Get a deal by ID - "list": List/filter deals - "update": Update deal fields by ID (set STAGE_ID to move/close) - "delete": Delete a deal (destructive) - "fields": Describe all deal fields - "category_list": List deal pipelines/categories (воронки) - "category_add": Create a pipeline/category - "category_update": Update a pipeline/category - "category_delete": Delete a pipeline/category (destructive) - "getProductRows": Get product rows of a deal - "setProductRows": Overwrite product rows (destructive — full rewrite) - "addProductRow": Add a product row to a deal - "getContactBindings": List contacts bound to a deal - "setContactBindings": Set contact bindings - "contact_add": Bind a contact to a deal - "contact_delete": Unbind a contact (destructive) - "contact_items_delete": Clear all contacts from a deal (destructive) - "getByCategory": List deals by category (filter by CATEGORY_ID) - "moveToCategory": Move a deal to another category (set CATEGORY_ID) - "count": Count deals matching filter (returns total) - "recurring_add": Add a recurring deal template - "recurring_get": Get a recurring deal template - "recurring_list": List recurring deal templates - "recurring_update": Update a recurring deal template - "recurring_delete": Delete a recurring deal template (destructive) - "recurring_expose": Expose a deal from a recurring template - "recurring_fields": Describe recurring deal fields - "details_get": Get deal card configuration (layout) - "details_set": Set deal card configuration - "details_reset": Reset deal card configuration to default - "userfield_get": Get a custom deal field - "userfield_add": Create a custom deal field - "userfield_update": Update a custom deal field - "userfield_delete": Delete a custom deal field (destructive) | |
| fields | No | Deal fields: TITLE (required), STAGE_ID, CATEGORY_ID, OPPORTUNITY, CURRENCY_ID, COMPANY_ID, CONTACT_ID, ASSIGNED_BY_ID. | |
| 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 | |
| userfield | No | User field definition | |
| categoryId | No | Pipeline/category ID | |
| contactIds | No | Contact IDs to bind | |
| userfieldId | No | CRM userfield ID (e.g. UF_CRM_123) | |
| configFields | No | Deal card configuration (details.configuration.*) fields | |
| categoryFields | No | Category fields: NAME | |
| recurringFields | No | Recurring deal template fields |