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-02T13:47:46Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2025-09-02T13:47:46Z", "CreateDate": "2025-09-02T13:47:46Z", "DisplayDate": "2025-09-02T13:47:46Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "b7cd1164-d594-4711-811b-eef37b174593", "ManageUserID": "29810652-c3dc-464b-b362-51e6d2461ffb", "ManageUserName": "sample string 9", "CreateUserID": "15bbdf5a-8ad1-4771-8b2d-e1f3e93ade9b", "CreateUserName": "sample string 11", "EditUserID": "b5ee7710-90e9-4bc0-ad2d-4bbf11dc172a", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "693fee46-ff67-4137-9831-c3478e037a7d", "d9632c3b-fa7b-499e-8eae-6dd7751b0c4f" ], "Companies": [ "b8fd78b5-e911-4ba5-ae83-22c65dfcc400", "d5f00812-76b4-4958-8f62-d2de9f73e490" ], "Groups": [ "2f492045-7a4e-4717-99dd-5f6a1be422a0", "b8358b98-bed7-49c6-805b-f6f51c4a7249" ], "Opportunities": [ "3b78bfb4-98f6-4afd-bb15-7e57a6d26750", "29ab1dd6-d657-4018-b885-5068066d380e" ] } }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.