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": "421083cd-9a45-4e98-b1c9-910cb3a3a27b", "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-19T00:41:12Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "1c38c204-94eb-49ee-a71b-3e677c37efba", "EditDate": "2024-05-19T00:41:12Z", "CreateDate": "2024-05-19T00:41:12Z", "StartTime": "2024-05-19T00:41:12Z", "EndTime": "2024-05-19T00:41:12Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "aeec350f-c89a-4c64-b8e3-1ca3c0d1f281", "439ba76f-48cc-43c6-8479-ecbce3dae872" ], "Companies": [ "1d98f8f5-0c57-4b40-81a8-b3686aad8552", "d8557026-15c6-4375-ac91-b8db7320559d" ], "Groups": [ "806cc703-9bb5-4229-a41e-f795d777b2e3", "2834c2f2-7af8-4b30-adf8-5a3eacb1aedc" ], "Opportunities": [ "50a382ba-ab3b-48cb-8d4c-bc7ed8bd3662", "39765581-7f48-4702-b47b-333dcc894047" ] } }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.