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": "2024-05-16T00:18:51Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2024-05-16T00:18:51Z", "CreateDate": "2024-05-16T00:18:51Z", "DisplayDate": "2024-05-16T00:18:51Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "a09b993a-cb2a-4677-ac06-2ad3702f0953", "ManageUserID": "370d9bff-475b-444d-83e7-5a7f6d5c069d", "ManageUserName": "sample string 9", "CreateUserID": "f23c8fea-fda7-4d82-8eca-5c2c7ef74188", "CreateUserName": "sample string 11", "EditUserID": "9472e55c-031b-4985-b113-6fe583dae513", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "67d06337-49fa-4bee-915a-38b3c16bb0f7", "61005ae7-b061-49ae-9a7b-809ed976629f" ], "Companies": [ "8c1b6755-0c6a-43eb-b45c-88b66e6d23e2", "b6fe50b3-c4d8-4e03-a37c-50c259b0eb2c" ], "Groups": [ "ae053562-dd84-4631-85a8-bccc99e830a7", "45b555dd-4d08-4560-a8b7-ac266097429e" ], "Opportunities": [ "4f45243d-5326-4a9d-b100-e7e9fbfad4af", "84cfc144-626d-497a-b4d8-3b1c27133497" ] } }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.