PUT api/Histories/{id}
Update an existing History. This is not a partial update therefore, please pass in the full History object to your request. For partial updates, use the PATCH endpoint
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Activity ID |
globally unique identifier |
Required |
Body Parameters
Serialized Activity record in the body of the request
HistoryName | Description | Type | Additional information |
---|---|---|---|
Id |
SQL Column Name: [HISTORYID] |
globally unique identifier |
None. |
Regarding |
SQL Column Name: [REGARDING] |
string |
None. |
Duration |
SQL Column Name: [DURATION] |
string |
None. |
OutlookID | string |
None. |
|
HistoryTypeID |
SQL Column Name: [HISTORYTYPEID] |
integer |
None. |
HistoryType | HistoryType |
None. |
|
Attachment | Attachment |
None. |
|
IsPrivate | boolean |
None. |
|
ManageUserId | globally unique identifier |
None. |
|
EditDate |
SQL Column Name: [EDIT_DATE] |
date |
None. |
CreateDate |
SQL Column Name: [CREATE_DATE] |
date |
None. |
StartTime |
SQL Column Name: [START_DATE_TIME] |
date |
None. |
EndTime |
SQL Column Name: [END_DATE_TIME] |
date |
None. |
Details |
SQL Column Name: [DETAILS] |
string |
None. |
LinkedEntities | LinkedEntities |
None. |
Request Formats
application/json, text/json
Sample:
{ "Id": "fb5c94f6-674f-455d-ba7e-7f7990326c3a", "Regarding": "sample string 2", "Duration": "sample string 3", "OutlookID": "sample string 4", "HistoryTypeID": 5, "HistoryType": { "Name": "sample string 1", "HistoryTypeId": 2, "Description": "sample string 3", "ActivityTypeID": "sample string 4", "ActivityTypeName": "sample string 5", "IsActive": true, "IsCustom": true, "IsDefault": true, "IsUserRecordable": true }, "Attachment": { "DisplayName": "sample string 1", "FileSize": 2.1, "LastModified": "2024-05-07T21:05:13Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "8ab69edf-5f71-447b-8f6a-57eb3264c6bc", "EditDate": "2024-05-07T21:05:13Z", "CreateDate": "2024-05-07T21:05:13Z", "StartTime": "2024-05-07T21:05:13Z", "EndTime": "2024-05-07T21:05:13Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "ab90d688-b213-4a6a-8cf4-22210253bf95", "4d91fdaa-c854-42a1-8c6d-baa8ae160307" ], "Companies": [ "3e7e729a-e00f-499c-912b-97697c786c38", "6dfee132-e773-4f6c-bba5-34a761663527" ], "Groups": [ "1e32c0ea-b3a3-4161-851e-78da617e8604", "3cf48e51-eb6d-4e34-8c40-dd520c393ab1" ], "Opportunities": [ "96450fbe-8a10-4532-975e-2953c4a765ae", "ef9324ad-bee0-437d-87cf-6eaaa492917e" ] } }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.