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": "2025-11-09T21:05:20Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"EditDate": "2025-11-09T21:05:20Z",
"CreateDate": "2025-11-09T21:05:20Z",
"DisplayDate": "2025-11-09T21:05:20Z",
"NoteText": "sample string 5",
"NoteTypeID": 6,
"ID": "02d9b67e-0177-4f99-8cc0-5af9bc793601",
"ManageUserID": "17f96d41-c67c-441d-9588-62c0d3e0da93",
"ManageUserName": "sample string 9",
"CreateUserID": "7c6471aa-aefc-4597-9381-71f6d76c4a0a",
"CreateUserName": "sample string 11",
"EditUserID": "795c0a07-06de-49fe-aa60-890c245197e5",
"EditUserName": "sample string 13",
"IsPrivate": true,
"LinkedEntities": {
"Contacts": [
"f2c8d2ee-6aba-45da-8fe2-bb32b01249a0",
"874c5ce6-b316-4877-81a8-706296eb9fe3"
],
"Companies": [
"1f071816-54fe-4719-8b79-b4846ad692e6",
"d389a77b-b503-4974-b80f-e3cc38b981f0"
],
"Groups": [
"82dc303d-3d31-4e3a-b21a-d437dace507f",
"ecaf8e1f-8771-4a86-9c8a-7f6d76dfeb26"
],
"Opportunities": [
"4c3dcc35-2b28-47cf-be80-c5c77dccb870",
"ba70fa9e-f7ad-4211-ab10-d1051685e05c"
]
}
}
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:
"402db0c9-1359-4a7b-b60c-5db895dfeb6d"