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-06-30T23:52:31Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"EditDate": "2026-06-30T23:52:31Z",
"CreateDate": "2026-06-30T23:52:31Z",
"DisplayDate": "2026-06-30T23:52:31Z",
"NoteText": "sample string 5",
"NoteTypeID": 6,
"ID": "d535961b-1664-49e0-a728-453fb53c0af3",
"ManageUserID": "b9700675-aabf-4819-a088-88264831d1b1",
"ManageUserName": "sample string 9",
"CreateUserID": "fd6ddf88-dfd9-41ed-a3b6-cf0b163bda76",
"CreateUserName": "sample string 11",
"EditUserID": "5da6c27d-5b93-41b9-808b-c1380496711c",
"EditUserName": "sample string 13",
"IsPrivate": true,
"LinkedEntities": {
"Contacts": [
"aa71874d-c714-43bd-b195-1d96abbaf0a3",
"502bc70f-4805-461f-900c-61b178fc8fef"
],
"Companies": [
"10685a64-aa05-4e8a-8386-f0361428423a",
"e719195d-a862-41fd-aca3-922f2ed5156f"
],
"Groups": [
"d88ecb73-b2c2-485a-8118-5301bbfbbc93",
"fa7ab8f1-d5b8-4cb4-9e7d-e9f47f8287df"
],
"Opportunities": [
"ba3c70a8-aed5-4a35-bd1d-e7de89c636df",
"4befdf0c-1ca9-4eb4-892f-47ca5c890305"
]
}
}
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:
"0b2ce5d3-53b9-42e2-a20f-70fce79e72c4"