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-02-04T14:48:20Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"EditDate": "2026-02-04T14:48:20Z",
"CreateDate": "2026-02-04T14:48:20Z",
"DisplayDate": "2026-02-04T14:48:20Z",
"NoteText": "sample string 5",
"NoteTypeID": 6,
"ID": "5d863f82-2358-4ad4-9116-3f7d767653c6",
"ManageUserID": "5fce3ffc-39d9-47e5-a422-43ec916a9574",
"ManageUserName": "sample string 9",
"CreateUserID": "70cd5359-ac65-4e67-89b3-0eb1d2c202a2",
"CreateUserName": "sample string 11",
"EditUserID": "b36bfb82-6576-48de-9f1a-4b7dbc5ce16a",
"EditUserName": "sample string 13",
"IsPrivate": true,
"LinkedEntities": {
"Contacts": [
"952faf77-a0a0-4084-89a5-9753df5f104c",
"24da28bf-1a14-4617-a064-b742c2004e3e"
],
"Companies": [
"3a59aeb1-02ad-46fa-a302-ded04ec4edfa",
"29c77871-bbf6-4310-888a-50fda22238c1"
],
"Groups": [
"597caddd-dd87-43a1-8bc5-7c0c6632cdc9",
"b65b37d6-8d3f-4709-aee6-696c423460b3"
],
"Opportunities": [
"5e57e6b7-e949-4ff7-a4df-47ee125717bb",
"4792b6f1-92df-445c-acf0-7c07af97bb26"
]
}
}
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:
"1ab7fa6b-4c9b-414c-a988-cacba7a4c699"