Sales Funnels: Overview of Methods

The methods crm.category.* manage funnels. A funnel is a separate branch of work with a CRM object that has its own set of stages and its own card settings.

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

Which Objects Support FunnelsWhich Objects Support Funnels

The object for which a funnel is needed is specified by the entityTypeId parameter. Not all CRM objects support funnels.

Object	entityTypeId
Deal	2
Contact	3
Company	4
Invoice	31
Smart Process	from 128

The smart process identifier is returned by the crm.type.list method, and the complete table of types is available in the CRM object types reference. For an object without funnel support, such as a lead, the crm.category.* methods will return the ENTITY_TYPE_NOT_SUPPORTED error.

Getting StartedGetting Started

1. Determine the entityTypeId of the object for which the funnel is needed.
2. Create a funnel using the crm.category.add method or find a suitable one among the existing funnels using the crm.category.list method.
3. Configure the stages of the new funnel using the crm.status.* methods: each funnel has its own reference of stages.
4. Link an item to the funnel: pass the funnel's id as categoryId in the crm.item.add or crm.item.update method.
5. If necessary, configure the card layout for this funnel using the crm.item.details.configuration.* methods.

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. Stages are handled by the crm.status.* methods. 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

Continue LearningContinue Learning

• Universal CRM Methods: Overview of Methods and Events
• Reference Guides in CRM: Overview of Methods
• Smart Processes: Overview of Methods and Events