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-05T02:50:31Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"EditDate": "2026-01-05T02:50:31Z",
"CreateDate": "2026-01-05T02:50:31Z",
"DisplayDate": "2026-01-05T02:50:31Z",
"NoteText": "sample string 5",
"NoteTypeID": 6,
"ID": "d0712a6c-d24c-44fb-adf2-2f009552c2e7",
"ManageUserID": "f5ef5294-9e00-4c49-9512-30d90afb8f0b",
"ManageUserName": "sample string 9",
"CreateUserID": "425d6fde-7ff7-46a5-a32d-d2cf5ace19ce",
"CreateUserName": "sample string 11",
"EditUserID": "829689db-affb-4f33-a3c8-f65865563899",
"EditUserName": "sample string 13",
"IsPrivate": true,
"LinkedEntities": {
"Contacts": [
"1435e71e-03ac-419f-9f21-0420b2470543",
"06c8bce6-5fad-40e7-95c3-ce88abe1a8ec"
],
"Companies": [
"d3d97cde-8e98-48e1-b5ee-194ed7c4d680",
"f0693ab0-e54e-4075-9d9f-ce6c5ca77c59"
],
"Groups": [
"6dd68946-26b3-4bbb-90b7-ff924e927785",
"61697365-0b8e-47a9-8a1a-ae0962273d31"
],
"Opportunities": [
"c7ec2bfe-46e8-49ec-ab92-bfb8da81997e",
"07992565-75cc-4729-83fc-91c356661ce9"
]
}
}
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:
"4f949db1-cfa1-4a1c-84bf-ab7d315a3121"