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-06T06:29:37Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"EditDate": "2026-02-06T06:29:37Z",
"CreateDate": "2026-02-06T06:29:37Z",
"DisplayDate": "2026-02-06T06:29:37Z",
"NoteText": "sample string 5",
"NoteTypeID": 6,
"ID": "44eafd4a-843d-4818-9ecd-fa756bc541e8",
"ManageUserID": "0d9dcd19-3bda-45c8-a61e-df72ed9fabe8",
"ManageUserName": "sample string 9",
"CreateUserID": "9408f8fc-a569-4e1a-97a2-0676202a9f34",
"CreateUserName": "sample string 11",
"EditUserID": "27c69e49-6af9-4d1a-aef7-c21b823cd7f5",
"EditUserName": "sample string 13",
"IsPrivate": true,
"LinkedEntities": {
"Contacts": [
"91f5ff29-bcd0-4786-b47a-3150165b37c4",
"0cdfdb58-ec80-4c09-be1e-97c79731cf06"
],
"Companies": [
"e11b6686-c8ee-4e27-9452-8d7ce0fcc338",
"0addffd4-881b-4302-8a6e-ea3cfbdef66e"
],
"Groups": [
"edc56804-a932-4249-bd60-48f4537e213a",
"52ba9fc3-053f-4a08-9d21-cd9e8e608b7f"
],
"Opportunities": [
"cd8f8135-ff42-4354-8ed7-ee8e9cbf2101",
"bc9d5996-6933-43cd-ae14-6b8873ac5adc"
]
}
}
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:
"7d8ddcae-bb8e-4be3-98ff-ea27bd74ddf9"