Notes
A simple notepad for reps to write down important information in their CRM. Notes help reps capture details about conversations, preferences, and other relevant information.
Notes can be associated to a Contact.
Rules
- Notes are always associated to a Contact
- Notes can have file attachments (images, PDFs, documents)
- Notes can be pinned for priority visibility
- Notes can have optional due dates and times
JSON Structure
{ "id": 12345, "company_id": null, "contact_id": 67890, "title": "Follow up with customer", "body": "Customer expressed interest in our premium package. They mentioned budget constraints but are open to a payment plan.", "note_type": "follow_up", "due_date": "2025-01-20", "due_time": "14:30:00", "due_at": "JAN 20 2025, 02:30 PM", "pinned": true, "assets": [ { "id": 456, "url": "https://example.com/file.pdf", "filename": "document.pdf", "content_type": "application/pdf", "content_size": 1024, "kind": "pdf", "metadata": {} } ], "created_at": "2025-01-15T10:30:00Z", "updated_at": "2025-01-15T10:30:00Z" }
API Endpoints
Company Scoped
Note: Company scoped endpoints will only return Notes for Contacts created on the Company's website or via the Company API.
| Verb | Endpoint | Description |
|---|---|---|
| GET | /api/company/crm/v202506/notes | List all notes |
| GET | /api/company/crm/v202506/notes/:id | Get a specific note |
| POST | /api/company/crm/v202506/notes | Create a new note |
| PATCH | /api/company/crm/v202506/notes/:id | Update a note |
| DELETE | /api/company/crm/v202506/notes/:id | Delete a note |
User Scoped
| Verb | Endpoint | Description |
|---|---|---|
| GET | /api/user/crm/v202506/notes | List user's notes |
| GET | /api/user/crm/v202506/notes/:id | Get a specific note |
| POST | /api/user/crm/v202506/notes | Create a new note |
| PATCH | /api/user/crm/v202506/notes/:id | Update a note |
| DELETE | /api/user/crm/v202506/notes/:id | Delete a note |
Next Steps
- Review the Core Elements Overview for API access patterns
- See Use Cases for examples of Notes in workflows
- Explore the User API Reference for detailed endpoint documentation