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-19T03:01:43Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2024-05-19T03:01:43Z", "CreateDate": "2024-05-19T03:01:43Z", "DisplayDate": "2024-05-19T03:01:43Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "fa18d6ad-1420-461c-8cef-407c08b0bd3d", "ManageUserID": "0bf8c9ad-a3f4-4429-9b33-9285969a47d0", "ManageUserName": "sample string 9", "CreateUserID": "f1b56346-5eaf-4639-9c5f-d83bea68cd76", "CreateUserName": "sample string 11", "EditUserID": "c81ecc1d-eedc-47b0-867a-49de885edd9e", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "586691c0-dd1b-4f33-9b01-154c6c5e8d4e", "c12b67d8-a805-4b70-b8db-2da6b0116777" ], "Companies": [ "dc81671f-f7d7-41c9-a2ea-21ae945d9948", "707eeffc-d994-4e55-853c-f87e7d678ed8" ], "Groups": [ "dbd4add9-68b6-47a3-9c35-155a0335b06c", "03b99f6b-087c-41e4-a5b2-1cde3a327129" ], "Opportunities": [ "bcd46f40-59f7-4d78-b27f-c3dbc8feea33", "bea076bd-3f88-4f04-807b-048a0231e06d" ] } }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.