POST api/Notes
Create a new Note
Request Information
URI Parameters
None.
Body Parameters
NoteName | Description | Type | Additional information |
---|---|---|---|
HasAttachment | boolean |
None. |
|
Attachment | Attachment |
None. |
|
EditDate |
SQL Column Name: [EDIT_DATE] |
date |
None. |
CreateDate |
SQL Column Name: [CREATE_DATE] |
date |
None. |
DisplayDate |
SQL Column Name: [NOTE_DATE] |
date |
None. |
NoteText |
SQL Column Name: [NOTE] |
string |
None. |
NoteTypeID |
SQL Column Name: [NOTETYPEID] |
integer |
None. |
ID |
SQL Column Name: [NOTEID] |
globally unique identifier |
None. |
ManageUserID | globally unique identifier |
None. |
|
ManageUserName |
SQL Column Name: [RECORD_MANAGER] |
string |
None. |
CreateUserID | globally unique identifier |
None. |
|
CreateUserName |
SQL Column Name: [RECORD_CREATOR] |
string |
None. |
EditUserID | globally unique identifier |
None. |
|
EditUserName |
SQL Column Name: [LAST_EDITED_BY] |
string |
None. |
IsPrivate |
SQL Column Name: [PRIVATE] |
boolean |
None. |
LinkedEntities | LinkedEntities |
None. |
Request Formats
application/json, text/json
Sample:
{ "HasAttachment": true, "Attachment": { "DisplayName": "sample string 1", "FileSize": 2.1, "LastModified": "2025-06-02T23:14:13Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2025-06-02T23:14:13Z", "CreateDate": "2025-06-02T23:14:13Z", "DisplayDate": "2025-06-02T23:14:13Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "2167553a-ce03-488f-97c1-cfc8c367ebd9", "ManageUserID": "50415eda-44f1-4478-a56e-82fac5fe49ed", "ManageUserName": "sample string 9", "CreateUserID": "bf616c4f-3cf1-4f5d-8cd8-cffbde6fea80", "CreateUserName": "sample string 11", "EditUserID": "7a5c3ca5-b923-465d-9d49-e5ac673be9ac", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "51bc8665-8694-4970-9ea7-244770d2695b", "239eae97-e119-4223-926f-ddff5264e232" ], "Companies": [ "58c40516-c0f9-41cd-b741-b71a19a691be", "4366d40d-e551-4c3e-8600-a5dbf50c8a43" ], "Groups": [ "55e6f897-e6e9-4943-865f-39e474924a27", "dd97ea30-4fbc-4e31-8647-136b33e98956" ], "Opportunities": [ "c2d0b78c-bf53-4786-95bc-b2184e63a63b", "9a946535-3319-4227-acd4-204845a3ffab" ] } }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Id of the new Note record
globally unique identifierResponse Formats
application/json, text/json
Sample:
"62bbd427-7565-4fc1-a81d-9ea79997c141"