Notes on Timeline Records: Overview of Methods

The group of methods crm.timeline.note.* works with text notes associated with timeline records. A note can be saved, retrieved, or deleted.

For example, if you need to save a call transcript to its corresponding deal timeline record, it can be added as a note and retrieved or deleted as necessary.

Quick navigation: all methods

User documentation: Timeline in CRM item form

Getting StartedGetting Started

1. Identify the CRM entity: ownerTypeId and ownerId
2. Define the record type itemType
3. Retrieve the itemId of the record based on itemType
4. Save the note using the crm.timeline.note.save method
5. To read the note, use the crm.timeline.note.get method
6. Delete the unnecessary note using the crm.timeline.note.delete method

Relationship with Other ObjectsRelationship with Other Objects

CRM Entities. The note is linked to a specific CRM entity: the entity type is passed in ownerTypeId, and the identifier is passed in ownerId. Typical values for ownerTypeId are listed in the article CRM Object Type. You can obtain the ownerId using the universal method crm.item.list.

Timeline History Records. The note is added to a comment in the timeline of the CRM entity. To link it, pass itemType = 1 and the record identifier itemId. To obtain itemId, use the crm.timeline.comment.add method when creating a comment or the crm.timeline.comment.list method for existing records.

CRM Activities. A note can also be added to a CRM activity in the timeline—such as a call, email, meeting, or task. To link it, pass itemType = 2 and the activity identifier itemId. Retrieve itemId from the response of the crm.activity.add method or from the list using the crm.activity.list method.

Universal CRM Activities. A universal activity is an advanced type of activity that includes synchronization with a calendar, selection of a meeting place, and negotiation room. To link it, just like a regular activity, pass itemType = 2 and the identifier itemId. Get itemId from the response of the crm.activity.todo.add method or from the list using the crm.activity.list method.

Overview of MethodsOverview of Methods

Scope: crm

Who can execute the method: any user

Method	Description
crm.timeline.note.save	Saves a note
crm.timeline.note.get	Returns information about the note
crm.timeline.note.delete	Deletes a note