Understanding notes
Core purpose
Notes serve as a central repository for documenting customer interactions, internal discussions, decisions, and other important account-related information that needs to be preserved and shared across teams.
Note types
Business notes
• General updates
• Meeting minutes
• Decision records
• Strategy documents
• Meeting minutes
• Decision records
• Strategy documents
Technical notes
• Implementation details
• Configuration changes
• Integration notes
• Troubleshooting logs
• Configuration changes
• Integration notes
• Troubleshooting logs
Standard fields
Required fields
| Name | Type | Options | Comments |
|---|---|---|---|
| Account ID | string | Required | Associated account identifier |
| Content | string | Required | Main content of the note |
Optional fields
| Name | Type | Options | Comments |
|---|---|---|---|
| Type | string | Optional | Note type reference |
| Visibility | enum | Optional | Access control (PUBLIC, PRIVATE, TEAM) |
| Attachment URLs | array | Optional | List of attachment URLs |
System-managed fields
| Name | Type | Options | Comments |
|---|---|---|---|
| Note ID | string | Auto-generated | Unique identifier for the note |
| UID | string | Auto-generated | Unique identifier (ULID) |
| Is Active | boolean | Default: true | Note’s active status |
| Author ID | string | Auto-populated | User who created the note |
| Created At | timestamp | Auto-populated | Creation timestamp |
| Updated At | timestamp | Auto-populated | Last update timestamp |
| Deleted At | timestamp | Optional | Soft delete timestamp |
Note organization
Best practices
Content quality
• Write clearly and concisely
• Use consistent formatting
• Include relevant context
• Maintain objectivity
• Use consistent formatting
• Include relevant context
• Maintain objectivity
Organization
• Use descriptive titles
• Apply appropriate tags
• Link related notes
• Set proper visibility
• Apply appropriate tags
• Link related notes
• Set proper visibility
API endpoints
Sample note
When creating a note, the system will add additional fields in the response such as:
id: Unique identifier for the noteaccount: Name of the associated accountauthor: Name of the note creatorauthorId: ID of the creatorauthorEmail: Email of the creatorcreatedAt: Creation timestampupdatedAt: Last update timestamp
Available operations
Note management
Note management
All endpoints require authentication with Bearer token, API key, and Organization ID in the headers.
Related resources
Accounts overview
Learn about account management
Activities
Track customer interactions