Sales Funnels: Overview of Methods

The methods crm.category.* manage the sales funnels of CRM entities that support categories: they create new funnels, modify settings, retrieve data by id or a list of funnels, delete a funnel, and return the composition of fields.

Funnels are used to separate work by departments or types of sales. They are most commonly configured for deals and Smart Process Automation (SPA). For example, to add a deal to a specific funnel, you retrieve the funnel's id using the crm.category.list method and pass it as categoryId in the crm.item.add method.

Quick Navigation: All Methods

User Documentation: Sales pipelines

Getting StartedGetting Started

1. Create a funnel using the crm.category.add method.

2. Link the funnel to the desired CRM entity in the crm.item.add or crm.item.update methods by passing the funnel's id as categoryId.

3. To check the settings of a specific funnel, retrieve its data by id using the crm.category.get method.

4. If you need to change the funnel parameters, use the crm.category.update method.

5. To get a list of funnels, use the crm.category.list method.

6. The available fields are returned by the crm.category.fields method.

7. To delete a funnel, use the crm.category.delete method.

Important ConsiderationsImportant Considerations

Access Permissions. The crm.category.list method is available to any user but only returns those funnels for which the user has read access. Methods for creating, modifying, and deleting require administrative access to CRM.

Default Funnel. The isDefault field behaves differently depending on the entity. In deals, it cannot be changed. In Smart Processes, a new default funnel can be assigned, causing the old one to lose that status. The isDefault flag cannot be removed from the current default funnel.

Deleting a Funnel. The crm.category.delete method will return an error if the funnel is the default funnel or contains elements.

Relationship with Other EntitiesRelationship with Other Entities

Deals. The crm.category.list method works with the funnels of deals. In deals, the funnel is linked to the entity through the categoryId field.

Smart Processes. Funnels in a Smart Process work if the object type has the isCategoriesEnabled option enabled. You can check the setting and retrieve the entityTypeId of the Smart Process using the crm.type.list method.

Stages. Each funnel defines its own reference of stages with a unique ENTITY_ID. To work with stages, use the methods in the CRM Reference. The identifiers of the references are returned by the crm.status.entity.types method.

Deal Cards. The settings of deal cards depend on the funnel. To configure a card for a specific funnel, pass the funnel's id as dealCategoryId in the crm.deal.details.configuration.get and crm.deal.details.configuration.set methods.

Overview of MethodsOverview of Methods

Scope: crm

Who can execute the method: depends on the method

Method	Description
crm.category.add	Creates a new funnel
crm.category.update	Updates a funnel
crm.category.get	Returns a funnel by id
crm.category.list	Returns a list of funnels
crm.category.delete	Deletes a funnel
crm.category.fields	Returns the description of funnel fields