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
NoteName | 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-09-18T09:33:40Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2025-09-18T09:33:40Z", "CreateDate": "2025-09-18T09:33:40Z", "DisplayDate": "2025-09-18T09:33:40Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "e3d04b2a-9f23-4199-b329-c3ed0dde9ccc", "ManageUserID": "68abf259-f74b-4e73-a31b-3150bfc070dd", "ManageUserName": "sample string 9", "CreateUserID": "70161ad1-66e9-467c-a3b7-94747225229e", "CreateUserName": "sample string 11", "EditUserID": "50e68321-e993-4061-9e04-39bfce35a07f", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "70fcb5c8-9f38-4eee-9765-833301cc9a25", "16c4f982-d99d-47bd-bd58-17d70e6715e3" ], "Companies": [ "8e3ff8e9-a923-4eb4-9b79-d6d9a3dfb32d", "0e6cb4e1-9d56-44a4-ad86-4c66bc7151e1" ], "Groups": [ "485727b6-b85d-46bf-84ed-72d39191f4ae", "ce9ab34b-b0af-4583-ae3d-d5f22e85df3f" ], "Opportunities": [ "e7f79050-3701-4b41-97d7-e390539c5f41", "46f014d3-886c-410b-85fa-cc57f45c37e9" ] } }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.