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-12T03:23:01Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"EditDate": "2026-01-12T03:23:01Z",
"CreateDate": "2026-01-12T03:23:01Z",
"DisplayDate": "2026-01-12T03:23:01Z",
"NoteText": "sample string 5",
"NoteTypeID": 6,
"ID": "d82ab71f-64d6-4d6c-89dd-e3e387694285",
"ManageUserID": "361044b0-7c24-43dc-86e3-eda209ff65e0",
"ManageUserName": "sample string 9",
"CreateUserID": "49ba3601-5d09-4625-92bd-fdd2ddd01873",
"CreateUserName": "sample string 11",
"EditUserID": "d3b9bf6b-8911-4499-af45-a4d4cb78e192",
"EditUserName": "sample string 13",
"IsPrivate": true,
"LinkedEntities": {
"Contacts": [
"091405c9-1d64-44ed-b3c8-ca3b16afd20d",
"5ac63cff-7dfe-4270-b457-78bd91b7a089"
],
"Companies": [
"d4355c7c-c5a5-4016-b690-789f0108066f",
"4a5e5d1d-1d5a-4feb-9ac5-c87d764c6848"
],
"Groups": [
"9186e04f-8799-4e82-81cd-83951c85677e",
"226016bb-a3b7-40b7-8991-c1c92818935d"
],
"Opportunities": [
"bc471280-92fc-46c7-862e-21100d763980",
"76d6d394-79a8-482e-94fc-59ed06c631d0"
]
}
}
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:
"022877e8-9fb0-42ee-ad0a-e28aa8c76f12"