PUT api/Notes/{id}
Update an existing Note. This is not a partial update therefore, please pass in the full Note object to your request. For partial updates, use the PATCH endpoint
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Note ID |
globally unique identifier |
Required |
Body Parameters
Serialized Note record in the body of the request
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-04-04T07:41:04Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"EditDate": "2026-04-04T07:41:04Z",
"CreateDate": "2026-04-04T07:41:04Z",
"DisplayDate": "2026-04-04T07:41:04Z",
"NoteText": "sample string 5",
"NoteTypeID": 6,
"ID": "1688a302-1358-4ce5-8a81-87a127c0ee4e",
"ManageUserID": "c938ee5c-bac9-4fb1-bf23-3538f0d78b84",
"ManageUserName": "sample string 9",
"CreateUserID": "199b42d5-004b-4ce8-b6ce-085390479a0b",
"CreateUserName": "sample string 11",
"EditUserID": "2212db4b-34b6-4a9a-b748-4104907b46cb",
"EditUserName": "sample string 13",
"IsPrivate": true,
"LinkedEntities": {
"Contacts": [
"174c15bf-6b2c-4ba4-a2da-d8e1b26494f2",
"d4d15f35-6b22-476f-861d-5cedd62a2a73"
],
"Companies": [
"950583fb-b9df-4a27-addd-512c9060d9d3",
"6ca92430-84a5-457d-af92-c350a6b678c3"
],
"Groups": [
"36cacc6b-209b-4245-bc8f-4c8e5eddbfad",
"f1ef3f90-01fe-4884-968a-c30494c0930b"
],
"Opportunities": [
"c7d602bc-12d5-4a80-b7e1-d02422b258bc",
"b457cc2d-07ca-4e12-9187-7cf61723236e"
]
}
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.