Note

Get details for a specific note

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

A note is a text document that can be linked to other major objects. Unlike the details fields that are available on the other major objects such as contacts, notes do not impose a length limit and are suitable for large blobs of text or data that needs to be stored and linked to a major object.

As with the other major objects, notes can be categorized, tagged with keywords, and linked to other records.

Attributes

NameTypeDescriptionAttributes
selfreferenceURL of the noteRead-only
Non-null
titlestringTitle of the note (max 512 characters)Read-Write
Non-null
Default value is "Untitled Note"
Searchable
detailsstringThe text of the note, as plain text. See DetailsRead-Write
Nullable
categorystringCategory nameRead-Write
Nullable
Searchable
keywordsarray of stringList of Keywords (max 64)Read-Write
Nullable
Searchable
appointmentsarray of linkLinked AppointmentsRead-Write
Nullable
Searchable
contactsarray of linkLinked ContactsRead-Write
Nullable
Searchable
companiesarray of linkLinked CompaniesRead-Write
Nullable
Searchable
groupsarray of linkLinked GroupsRead-Write
Nullable
Searchable
formsarray of linkLinked FormsRead-Write
Nullable
Searchable
opportunitiesarray of linkLinked OpportunitiesRead-Write
Nullable
Searchable
projectsarray of linkLinked ProjectsRead-Write
Nullable
Searchable
tasksarray of linkLinked TasksRead-Write
Nullable
Searchable
ownerreferenceURL of the User responsible for the noteRead-Write
Non-null
Default value is the user making the request
Searchable
creatorreferenceURL of the User that created the noteRead-only
Non-null
Searchable
trashedbooleanWhether the note is in the trash. Set to false to restore itRead-only
Non-null
create_datedatetimeWhen the note was createdRead-only
Non-null
Searchable
modify_datedatetimeWhen the note was last updatedRead-only
Non-null
Searchable

Details

details is plain text. Line breaks are kept, but formatting isn't: the API stores whatever you send as plain text, so don't send RTF or HTML. Notes written in the Daylite app may have formatting, and the API returns their plain-text version.

Send "" to clear the details. null is rejected with {"details": [{"error": "blank"}]}.

Path Params
int32
required

The note ID

Query Params
boolean

Return a smaller version of the record that leaves out lists and linked records.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json