ContentNote | Object Reference for Salesforce and Lightning Platform

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update()

Special Access Rules

Notes must be enabled.

Fields

Field	Details
Content	Type base64 Properties Create, Nillable, Update Description The content or body of the note, which can include properly formatted HTML or plain text. When a document is uploaded or downloaded via the API, it must be base64 encoded (for upload) or decoded (for download). Any special characters within plain text in the Content field must be escaped. You can escape special characters by calling `content.escapeHtml4()`. If the input contains unsafe HTML characters, we automatically strip them out before saving the content.
ContentModifiedDate	Type dateTime Properties Filter, Nillable, Sort Description Date the document was modified. ContentModifiedDate updates when, for example, the document is renamed or a new document version is uploaded. This field is available in API version 48.0 and later.
ContentSize	Type int Properties Filter, Group, Nillable, Sort Description Size of the note in bytes.
CreatedById	Type reference Properties Create (for users assigned the Set Audit Fields Upon Creation permission), Defaulted on createFilter, Group, Sort, Update (for users assigned the Set Audit Fields Upon Creation permission) Description ID of the user who created the note.
CreatedDate	Type dateTime Properties Create (for users assigned the Set Audit Fields Upon Creation permission), Defaulted on create, Filter, Sort, Update (for users assigned the Set Audit Fields Upon Creation permission) Description Date the note was created.
FileExtension	Type string Properties Filter, Group, Nillable, Sort Description File extension of the note.
FileType	Type string Properties Filter, Group, Nillable, Sort Description Type of file for the note. All notes have a file type of SNOTE.
Id	Type id Properties Defaulted on createFilter, Group, Nillable, Sort Description ID of the note.
IsDeleted	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the note has been deleted.
IsReadOnly	Type boolean Properties Defaulted on create, Group, Sort Description Indicates whether the note is read only.
LastModifiedById	Type reference Properties Defaulted on create, Filter, Group, Sort, Update (for users assigned the Set Audit Fields Upon Creation permission) Description The ID of the user who last modified the note.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description Date the note was last viewed. This field is available in API version 35.0 and later.
LatestContentId	Type reference Properties Filter, Group, Nillable, Sort Description Lookup to the note's ContentBody. This field is available in API version 52.0 and later. This is a relationship field. Relationship Name LatestContent Relationship Type Lookup Refers To ContentBody
LatestPublishedVersionId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the ContentVersion for the latest published version of the note.
OwnerId	Type reference Properties Create (for users assigned the Set Audit Fields Upon Creation permission), Defaulted on create, Filter, Group, Sort, Update (for users assigned the Set Audit Fields Upon Creation permission) Description ID of the owner of the note.
SharingPrivacy	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Controls sharing privacy for a file. Only administrators and file owners with Collaborator access to the file can modify this field. Default is Visible to Anyone With Record Access. When set to Private on Records, the file is private on records but can be shared selectively with others. This field is available in API versions 41.0 and later.
TextPreview	Type string Properties Filter, Group, Nillable, Sort Description A preview of the note’s content. This field is available in API version 35.0 and later.
Title	Type string Properties Create, Filter, Group, idLookup, Namefield, Sort, Update Description Title of the note.

Usage

Use ContentNote to create, query, retrieve, search, edit, and update notes.
ContentNote is built on ContentVersion, and so it has many of the same usages.
Not all fields can be set for notes. Only the Content and Title fields can be updated.
The maximum file size you can upload via SOAP API is 50 MB. When a document is uploaded or downloaded via the API, it’s converted to base64. This conversion increases the document size by approximately 37%. Account for the base64 conversion increase so that the file you plan to upload is less than 50 MB after conversion.
You can convert old Note records to Lightning Experience, so users can view and edit notes from the Notes & Attachments related list in Lightning Experience. Users can edit their converted notes, which are accessible from the Notes related list and Notes tab. Copy old Note records to newly created ContentNote records. Users assigned the Set Audit Fields Upon Creation permission can set the owner, created date, and last modified date on ContentNote records.
SOQL and SOSL queries on the ContentNote return only the most recent version of the note.
To relate a note to a record, use ContentDocumentLink.

For example, the following Apex code creates a note and escapes any special characters so they’re converted to their HTML equivalents.

Apex code doesn’t need to be encoded to base64 before it’s uploaded and downloaded.

Note

1ContentNote cn = new ContentNote();
2cn.Title = 'test1';
3String body = 'Hello World. Before insert/update, escape special characters such as ", ', &, and other standard escape characters.';
4cn.Content = Blob.valueOf(body.escapeHTML4());
5insert(cn);

In this example, the following code creates a note using text that is already formatted as HTML, so it doesn’t need to be escaped.

1ContentNote cn = new ContentNote();
2cn.Title = 'test2';
3String body = '<b>Hello World. Because this text is already formatted as HTML, it does not need to be escaped. 
4Special characters such as &quot;, etc. must already use their HTML equivalents.</b>';
5cn.Content = body;
6insert(cn);