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-01T14:23:09Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"EditDate": "2026-02-01T14:23:09Z",
"CreateDate": "2026-02-01T14:23:09Z",
"DisplayDate": "2026-02-01T14:23:09Z",
"NoteText": "sample string 5",
"NoteTypeID": 6,
"ID": "530e1e0b-96ad-4c1e-8988-8d5192b0e5e7",
"ManageUserID": "e0f92579-40fb-4a95-b5ab-b365101ba933",
"ManageUserName": "sample string 9",
"CreateUserID": "88c0bc57-a7bc-464a-84d6-a67e3aa00673",
"CreateUserName": "sample string 11",
"EditUserID": "03e9de98-1058-473b-8d94-8e080be03360",
"EditUserName": "sample string 13",
"IsPrivate": true,
"LinkedEntities": {
"Contacts": [
"71ac2122-0f94-4761-b8ac-d36f449c3968",
"8f39ff68-2766-4d75-b535-31ea8ae62a9e"
],
"Companies": [
"65487a48-c355-427c-911b-e287708276b5",
"f3c0a03a-debb-4022-8ead-cef8502d0110"
],
"Groups": [
"c8cc61bb-89cf-464d-bb8f-66d5198e5c5a",
"e3238eec-6b7e-4b7d-819b-53e7c24fdcde"
],
"Opportunities": [
"9cb40270-32db-4671-9a15-4ae1f757b6d5",
"005ad456-672a-4ff3-b520-90c810354c5b"
]
}
}
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:
"bec1f19f-bd92-4135-909d-0082bd3ffc1d"