close anchor

Note

The note data object.

Field Type Description
id string The UUID of the note for which data is being provided.
date_time object The init and edit date/time this entry was initially posted, and that of its latest known edit or update, both provided in ISO 8601 format.
user object The user identified as posting this note, if that user exists and is not deleted. Includes only the user id.
title string The title of the note.
text string The textual body of the note.
locale string The locale identified with the note text, being that used for the initial POST endpoint transaction.
entity object The type of entity identified with this note, and the id of each, being a one-dimensional indexed array in which each value is the UUID of an individual entity of the type indicated, on which further information is provided below.
users array If provided, the id or email of each user identified with this note, based on the entities to which it is posted.
emailed array The date/time(s) this note has been e-mailed to the user(s) identified with it, each being provided in ISO 8601 format. In order for this to be known, the event would first be logged via posting to the /note/email endpoint.

The entity type indicates the type of entity to which the note is posted, and in turn provides the basis for identifying both the user(s) for whom posting is enabled and to whom it is to be presented.

Contact

If the contact entity type is indicated, the note is intended for the user(s) identified with the contact(s) to which it is posted (by id).

Content

If the content entity type is indicated, the note is intended for the user(s) identified with the content entries to which it is posted (by id).

Group

If the group entity type is indicated, the note is intended for the users in the group(s) to which it is posted (by id).

In order to post a note to a group, log in a user in that group or with owner-level privileges.

Project

If the project entity type is indicated, the note is intended for project-wide distribution.

In order to post a note to the project and everyone in it, log in a user with editor-level privileges.

User

If the user entity type is indicated, the note is intended exclusively for the user(s) to whom it is posted (by id).

Register for an Invitation
Thank you!
We'll be in touch.
First Name*
Last Name*
(optional) Business Name
Role*
Email*