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-12T12:35:07Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"EditDate": "2026-01-12T12:35:07Z",
"CreateDate": "2026-01-12T12:35:07Z",
"DisplayDate": "2026-01-12T12:35:07Z",
"NoteText": "sample string 5",
"NoteTypeID": 6,
"ID": "5bf371b4-dfbd-4a89-a405-9915ba675883",
"ManageUserID": "443acaff-5920-457e-82dc-18b82c84145f",
"ManageUserName": "sample string 9",
"CreateUserID": "ccf80a0c-755d-4ea6-9e46-a137ea53a41e",
"CreateUserName": "sample string 11",
"EditUserID": "2d1b2d9c-ee60-4d94-a498-049e81218dc2",
"EditUserName": "sample string 13",
"IsPrivate": true,
"LinkedEntities": {
"Contacts": [
"cbbcb456-82fc-45d9-9dec-68b7f6b26021",
"392b26d8-d639-4aad-a2b9-7f240298ecf4"
],
"Companies": [
"a8b51e7d-49bb-4b5c-9909-ee69a1c2039c",
"f38f8d98-512d-49f7-9098-faf12b0f7a3b"
],
"Groups": [
"890f7b9c-dd8b-44b4-a4ae-2b48ebc235fc",
"670da5a4-6b93-453f-9d74-3e65b4fb27b1"
],
"Opportunities": [
"d7e530ff-bee4-4b8f-87e0-5a932e9f0099",
"bdc58fae-5dbb-4d12-9336-485bab68ab62"
]
}
}
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:
"bd1f29e3-7cdf-4b79-b3a7-f3f95efc322b"