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-29T13:30:18Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"EditDate": "2026-01-29T13:30:18Z",
"CreateDate": "2026-01-29T13:30:18Z",
"DisplayDate": "2026-01-29T13:30:18Z",
"NoteText": "sample string 5",
"NoteTypeID": 6,
"ID": "4ec8365d-006c-468e-a4ff-1da5127a535c",
"ManageUserID": "84efaef6-292b-46b4-8fc9-c8ecda344b60",
"ManageUserName": "sample string 9",
"CreateUserID": "8911ae0c-20e2-4f68-b11c-7853c88128fe",
"CreateUserName": "sample string 11",
"EditUserID": "0d99d810-bf93-490b-8f3e-96c8dfe6bc18",
"EditUserName": "sample string 13",
"IsPrivate": true,
"LinkedEntities": {
"Contacts": [
"19a9b6ee-faa4-4253-a9be-a36f34fc14b6",
"a3b7d6d2-a9e8-4325-935e-6a55e86f99b4"
],
"Companies": [
"ce9264a7-0975-4313-8306-96af369aa922",
"b5d43875-2770-4e15-99ca-9edec90df74b"
],
"Groups": [
"c3944be2-e4b2-406e-bc4e-9e51c85e725b",
"4f6935cf-1cf7-4fc4-aec3-35cea8769a60"
],
"Opportunities": [
"748f426d-3fa9-4805-822a-f648f38e5786",
"0a814dd3-2890-4fc3-ba43-6770d6b1b11e"
]
}
}
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:
"b4085fb9-8070-4a94-a575-b0e9c8037526"