POST {version}/AddNote
Add Note to Entities
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
version | string |
None. |
Body Parameters
FilterNoteName | Description | Type | Additional information |
---|---|---|---|
FilterId | globally unique identifier |
None. |
|
EntityIds | string |
None. |
|
Note | string |
None. |
|
NoteDate | date |
None. |
Request Formats
application/json, text/json
Sample:
{ "FilterId": "b08e32cd-bc66-4269-9235-1a22f4a30cd5", "EntityIds": "sample string 1", "Note": "sample string 2", "NoteDate": "07/09/2025" }
application/xml, text/xml
Sample:
<FilterNote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model.Contact"> <EntityIds>sample string 1</EntityIds> <FilterId>b08e32cd-bc66-4269-9235-1a22f4a30cd5</FilterId> <Note>sample string 2</Note> <NoteDate>2025-07-09T05:57:51.3534135-04:00</NoteDate> </FilterNote>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
count of entities impacted
ResultName | Description | Type | Additional information |
---|---|---|---|
Count | integer |
None. |
|
Success | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Count": 1, "Success": true }
application/xml, text/xml
Sample:
<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model"> <Count>1</Count> <Success>true</Success> </Result>