Please Note: Logged in user must have the permission to manage the client for adding or updating the Notes for client.
Endpoint:/
Method: GET
Description: Retrieves all notes for a specific entity type and ID
Permissions:viewNotes permission on the entity
Response:
Endpoint:/
Method: POST
Description: Creates Notes in Client section
Permissions: manage.webleads|only.view.clients|manage.assigned.office.clients
Payload:
{ "title": "Client Meeting Notes", "description": "<p>Discussed project requirements and timeline.</p>" //Accepts HTML } |
Response:
Status (if success) : 201
Endpoint:/{note_id}
Method: PATCH
Description: Updates an existing note
Permissions: editNotes permission on the note's notable entity and user_id
Parameter: note_id (path parameter): The ID of the note
Payload:
{ "title": "Updated Meeting Notes", "description": "<p>Updated project requirements and timeline.</p>" } |
Response:
{ "data": {} } |
Status (if success) : 200
Endpoint:/{note_id}
Method: DELETE
Description: Deletes an existing note
Permissions:deleteNotes permission on the note's notable entity and user_id
Parameter: note_id (path parameter): The ID of the note
Response:
Status (if success) : 204
