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-07T19:16:10Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2024-05-07T19:16:10Z", "CreateDate": "2024-05-07T19:16:10Z", "DisplayDate": "2024-05-07T19:16:10Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "1259395e-2d81-4b6d-b472-0bdbae709d53", "ManageUserID": "21019861-5cd2-43d3-85ab-d71c7406795d", "ManageUserName": "sample string 9", "CreateUserID": "ced6ffcf-3c3e-4367-b226-4eb9cf931b92", "CreateUserName": "sample string 11", "EditUserID": "80b33cae-93a1-4745-ba66-4d4bd8fbd372", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "c3fef0c9-05e7-41a5-8d0f-984592e0e822", "14170d32-0452-4c67-90c0-450f0d6f698a" ], "Companies": [ "1a1bf402-915c-43d7-8ef2-419592bc04a6", "940462e3-64b9-4d92-844a-861b215ea727" ], "Groups": [ "11dc182b-8b84-4daf-aebf-16f3bcc0475b", "7122b048-8c0a-466c-b0e8-016fa56f9165" ], "Opportunities": [ "aef5d36c-454e-46da-8c98-6e3131641118", "6606f4d9-b813-4280-99a6-e2bcd46e7b97" ] } }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.