POST api/Notes
Create a new Note
Request Information
URI Parameters
None.
Body Parameters
Note| Name | 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": "2026-01-26T13:37:08Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"EditDate": "2026-01-26T13:37:08Z",
"CreateDate": "2026-01-26T13:37:08Z",
"DisplayDate": "2026-01-26T13:37:08Z",
"NoteText": "sample string 5",
"NoteTypeID": 6,
"ID": "5aa13c23-30ca-4f7a-b175-630ee0209afa",
"ManageUserID": "95bf4fb3-9092-4de5-9909-b22bb9d631cf",
"ManageUserName": "sample string 9",
"CreateUserID": "c9624c56-66ab-4a90-b4aa-6b6064b261eb",
"CreateUserName": "sample string 11",
"EditUserID": "1a16ce8f-e59d-461a-995c-0dfb07f3a826",
"EditUserName": "sample string 13",
"IsPrivate": true,
"LinkedEntities": {
"Contacts": [
"68fa16cf-ee48-4ec9-96ea-c3ad30708a9f",
"c7a3083a-7289-4054-aa58-9838e293b8f3"
],
"Companies": [
"8164c352-1760-4839-b273-c592f7e6688a",
"94216d92-fdab-4206-b435-353445b737ae"
],
"Groups": [
"f6a8ff6c-0775-495f-ac4b-514e541556bc",
"211338e9-720d-4241-af23-7236fb0c6a3a"
],
"Opportunities": [
"c2200770-f05b-46fa-b1bb-474844deaae7",
"953e14f5-4f85-4c86-b1e5-0f5153739c44"
]
}
}
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:
"6f5711d2-4741-4d13-b6c3-203e45247a61"