CRM Activities in the Timeline: Methods Overview

A CRM activity is a timeline entry that records an interaction with a customer. It is linked to a CRM item and displayed within its card.

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

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

Quick navigation: All Methods

User documentation: Timeline in the CRM Card

Getting StartedGetting Started

1. Identify the CRM entity: ownerTypeId and ownerId
2. Create a universal activity using the crm.activity.todo.add method
3. Verify the created activity using the crm.activity.get method
4. To modify a universal activity, use the crm.activity.todo.update method
5. To find activities by filter, use the crm.activity.list method
6. Delete the required activity using the crm.activity.delete method
7. To retrieve a completed call transcription, use the crm.activity.call.getTranscript method
8. To check the activity field structure, use the crm.activity.fields method
9. Check the communication field structure using the crm.activity.communication.fields method

Connection with Other ObjectsConnection with Other Objects

CRM items. An activity is linked to a CRM item via the ownerTypeId and ownerId parameters. The crm.enum.ownertype method returns standard values ownerTypeId for leads, deals, contacts, and companies. For SPAs, use the crm.type.list method. Retrieve the ownerId identifier via the universal crm.item.list method.

Activity links. A single activity can be linked to multiple CRM items. To manage links—adding, moving, and deleting—use the crm.activity.binding.* method group.

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.call.getTranscript	Returns a ready-made call transcription
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