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-30T23:30:39Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"EditDate": "2025-11-30T23:30:39Z",
"CreateDate": "2025-11-30T23:30:39Z",
"DisplayDate": "2025-11-30T23:30:39Z",
"NoteText": "sample string 5",
"NoteTypeID": 6,
"ID": "80ca9e23-354f-487a-a4f5-6658dc46552d",
"ManageUserID": "33e72a5b-e658-4019-9a0b-7c6bb854b504",
"ManageUserName": "sample string 9",
"CreateUserID": "d5cd1172-f3a9-457f-9479-c3108a0716c3",
"CreateUserName": "sample string 11",
"EditUserID": "0121d235-5b27-4278-82a7-b2a0488d4148",
"EditUserName": "sample string 13",
"IsPrivate": true,
"LinkedEntities": {
"Contacts": [
"8e734134-198a-4e34-950d-f27bfcf5eac7",
"88e148ea-70e3-4cac-98d5-465e00ac3f7e"
],
"Companies": [
"18375ee8-fc6e-46fc-9281-309802c2013e",
"0e8851bb-cca5-40a6-917d-57909ee055dd"
],
"Groups": [
"4b650faf-2afa-47f8-8e66-b7d24b39be39",
"9ce6d44a-7d79-4afd-9bf7-26a221e5d185"
],
"Opportunities": [
"9c4e0c88-5b34-46dc-b4a2-b668433cbf67",
"83524d97-2ac6-4d12-b0db-ec7525650f12"
]
}
}
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:
"5613b76a-e245-4410-a74b-b49baac53940"