CRM Methods of the Previous API Version: Overview

The methods of the previous API version are called at the /rest/ address and are kept to support existing integrations. CRM methods in REST 3.0 are intended for new development, and they are described in the CRM overview. You can call methods of both versions from the same integration.

Quick navigation: all sections and methods

Universal Methods and Object MethodsUniversal Methods and Object Methods

In the previous version, CRM items are handled by two sets of methods:

• the universal methods crm.item.* — the same methods for all types, with the object type passed in the entityTypeId parameter. Field names are written in camelCase, for example assignedById
• the object methods crm.deal.*, crm.lead.*, crm.contact.*, crm.company.*, crm.quote.* — a separate set for each type. Field names are written in uppercase, for example ASSIGNED_BY_ID

SPA types are created and configured with the crm.type.* methods. REST 3.0 has no equivalents of these methods, so integrations built on REST 3.0 need them as well.

The REST 3.0 equivalents of the methods, their limitations, and the differences between the versions are described on the Migrating to the New CRM Methods page.

Overview of Sections and MethodsOverview of Sections and Methods

Scope: crm

Who can execute the method: depending on the method

Reference MaterialsReference Materials

Article	Description
Data Types and Structure of Objects in the REST API CRM	What is entityTypeId, what identifiers exist, and how CRM entities are structured
Fields of Main CRM Entities	Fields of key CRM entities in one place
CRM Field Length Limits	Maximum length of standard CRM fields and how to get custom field limits

CRM ObjectsCRM Objects

Section	When to Use	Key Methods
Universal CRM Methods	For working with CRM entities and Smart Processes through entityTypeId	crm.item.add, crm.item.update, crm.item.list All methods in the section
Deals	For working with deals, their cards, and relationships with contacts	crm.deal.add, crm.deal.update, crm.deal.list All methods in the section
Leads	For working with leads, their cards, and relationships with contacts	crm.lead.add, crm.lead.update, crm.lead.list All methods in the section
Contacts	For working with contacts, their cards, and relationships with companies	crm.contact.add, crm.contact.update, crm.contact.list All methods in the section
Companies	For working with companies, their cards, and relationships with contacts	crm.company.add, crm.company.update, crm.company.list All methods in the section
Estimates	For working with estimates and product items	crm.quote.add, crm.quote.update, crm.quote.list All methods in the section

Settings and DirectoriesSettings and Directories

Section	When to Use	Key Methods
Requisites	For working with requisites, addresses, and banking information in CRM	crm.requisite.add, crm.requisite.update, crm.requisite.list All methods in the section
Directories	For managing system lists in CRM: stages, sources, types	crm.status.add, crm.status.update, crm.status.list All methods in the section
Auxiliary Objects	For working with enumerations, multiple fields, and other auxiliary CRM objects	crm.enum.ownertype All methods in the section

Individual MethodsIndividual Methods

Method	Description
crm.settings.mode.get	Returns the current mode of CRM