Documentation

SPA pipelines

Description


Required parameter entityTypeId

All methods must receive the parameter entityTypeId, with written CRM entity type ID.

When entity type doesn't support handling of pipelines (for example, leads or quotes), methods won't work.


Default pipelines

Each entity type can have only one default pipeline. Due to this, there are several limits:

  • you cannot delete default pipeline;
  • when creating new pipeline and passing a flag "isDefault": "Y", the old default pipeline stops having the default status;
  • when editing default pipeline, you cannot change its status to non-default pipeline;
  • when updating non-default pipeline with passing the flag "isDefault": "Y", the old pipeline stops being a default pipeline.

Pipelines display inside UI is disabled for the existing SPA; you can, however, handle pipelines via REST.

Методы

Methods for handling deal and smart process automation pipelines are described in a separate section.

MethodsDescription
crm.category.fieldsPasses information about pipeline fields.
crm.category.getPasses information about pipeline with id.
crm.category.listReturns array with pipelines for entity type with entityTypeId.
crm.category.addCreates new pipeline with fields for entity type with entityTypeId.
crm.category.updateUpdates pipeline with id, by specifying new field values from fields.
crm.category.deleteDeletes pipeline with id for entity type with entityTypeId.


© «Bitrix24», 2001-2024
Up