CRM Activities in the Timeline: Overview of Methods

A CRM activity is a record in the timeline that captures interactions with a client. It is linked to a CRM entity and displayed in its detail form.

The methods in this section work with CRM activities: they create and update universal activities, return an activity by its identifier, retrieve a list based on a filter, delete an activity, and describe fields.

For example, if you need to remove a call from the timeline of a deal, you would retrieve the list of activities for that deal and delete the desired activity.

Quick navigation: all methods

User documentation: Timeline in CRM item form

Getting StartedGetting Started

1. Define the CRM entity: ownerTypeId and ownerId
2. Create a universal activity using the method crm.activity.todo.add
3. Verify the created activity using the method crm.activity.get
4. To modify the universal activity, use the method crm.activity.todo.update
5. To find activities based on a filter, use the method crm.activity.list
6. Delete the desired activity using the method crm.activity.delete
7. To check the structure of the activity fields, use the method crm.activity.fields
8. Verify the structure of the communication fields using the method crm.activity.communication.fields

Linking to Other ObjectsLinking to Other Objects

CRM Entities. An activity is linked to a CRM entity through the parameters ownerTypeId and ownerId. The typical values of ownerTypeId for leads, deals, contacts, and companies are returned by the method crm.enum.ownertype. For smart processes, use the method crm.type.list. The identifier ownerId can be obtained through the universal method crm.item.list.

Activity Links. One activity can be linked to multiple CRM entities. To manage these links—adding, transferring, and deleting—use the methods from the group crm.activity.binding.*.

Overview of MethodsOverview of Methods

Scope: crm

Who can execute the method: depends on the method

Method	Description
crm.activity.todo.add	Adds a universal activity to the timeline
crm.activity.todo.update	Updates a universal activity
crm.activity.get	Returns an activity by its identifier
crm.activity.list	Returns a list of activities based on a filter
crm.activity.delete	Deletes an activity
crm.activity.fields	Returns the description of the activity fields
crm.activity.communication.fields	Returns the description of the communication fields of the activity

Deprecated MethodsDeprecated Methods

Method	Description
crm.activity.add	Creates a system activity
crm.activity.update	Updates a system activity