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-08-29T12:29:43Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"EditDate": "2026-08-29T12:29:43Z",
"CreateDate": "2026-08-29T12:29:43Z",
"DisplayDate": "2026-08-29T12:29:43Z",
"NoteText": "sample string 5",
"NoteTypeID": 6,
"ID": "807c9f0d-612b-4989-a4af-5f265f580dd7",
"ManageUserID": "92167cd8-0dea-4826-a8dd-f8f9cd159c31",
"ManageUserName": "sample string 9",
"CreateUserID": "1bf8f0d7-828a-4419-a67c-69aaa9e9c775",
"CreateUserName": "sample string 11",
"EditUserID": "0681a6e0-6a2a-420c-81f3-507db58e7f2f",
"EditUserName": "sample string 13",
"IsPrivate": true,
"LinkedEntities": {
"Contacts": [
"6a52a020-7da2-40a9-96e7-c645e442bec0",
"75852ebc-9909-4bb5-994c-d50f50f00365"
],
"Companies": [
"20a95bd8-99f3-4691-9ca5-4af0e8aaf588",
"58beab8b-9a8c-4764-a35b-ac420e1c35b7"
],
"Groups": [
"aaf0aec7-d176-413a-a9d0-fe25d7d2d379",
"08d3132a-db1a-449b-952a-89c5938e3657"
],
"Opportunities": [
"c2e08438-e351-46e8-a348-2c23df5276d5",
"51217668-1a51-4ada-bd9a-c5c804400171"
]
}
}
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:
"4a243154-a164-4937-8589-0b419cf43da1"