Notes
A note records information against a customer or account. The API lets you create and manage notes programmatically. See the Notes guide for how they are used.
Methods
Section titled “Methods”Retrieve Single Note
Section titled “Retrieve Single Note”/backend/api/v1/notes/ID - fetch the note with the specified ID.
List Notes
Section titled “List Notes”/backend/api/v1/notes/ - list all notes.
/backend/api/v1/customers/ID/notes/ - list notes for the customer with the specified ID.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include notes with a higher ID |
createdSince | datetime | No | Only include notes created since the given time |
updatedSince | datetime | No | Only include notes updated since the given time |
/backend/api/v1/customers/ID/notes/ - add a new note to the specified customer. The newly-added note will be returned.
/backend/api/v1/notes/ID - update the note with the specified ID. The modified note will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/notes/ID - delete the note with the specified ID.
Attachments
Section titled “Attachments”/backend/api/v1/notes/ID/noteAttachments - add a file to the note with the specified ID, by either of the methods in File Uploads.
/backend/api/v1/noteAttachments/ID - fetch an attachment’s details or its file content, or update it with PATCH.
Note attachments are checked in the same way as files attached through the platform’s own note form:
- Size: up to 100 MB, measured on the original file. A compressed upload that would expand beyond 100 MB is refused before it is expanded. An oversized file returns HTTP 400 with error code
400915. - Malware scan: every file is scanned, and a file the scan refuses returns HTTP 400 with error code
400916. - Compression: the JSON method accepts
gzip,zlib,bzip2orzstdin_compression. Any other scheme, includinglzf, returns error code400904.
Access
Section titled “Access”A note with no customer is reached through its allocation rather than by customer scoping. See Unlinked Notes, TODOs and Tickets.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| noteType | Type | Preset Value | The type of note |
| status | Status | Preset Value | Current status of this note |
| owner | Owner | Preset Value | The user who owns/is responsible for this note |
| departments | Departments | Preset Value(s) | Departments that have visibility of this note |
| createdDate | Date | Date | The date this note was created |
| actionDate | Action Required | Date | Date by which action is required on this note |
| subject | Subject | Text | Subject line for this note |
| body | Note | Text (Multiline) | Main content of the note |
| containsPersonalData | Contains Personal Data | Preset Value | Indicates whether this note contains personal data subject to data protection regulations |
| id | Note ID | Text | The unique identifier for this note |
| attached | Attached to | HTML |