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": "81714376-a41c-4ad9-adae-3dfb2dde4661", "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": "2025-09-02T20:33:28Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "d44fa029-884f-4d80-9847-2edc53d279c4", "EditDate": "2025-09-02T20:33:28Z", "CreateDate": "2025-09-02T20:33:28Z", "StartTime": "2025-09-02T20:33:28Z", "EndTime": "2025-09-02T20:33:28Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "e21ba8f3-7660-46c4-87f6-2fa399c6a1d5", "fdd4a4aa-df93-43c0-8372-19fd89efb35c" ], "Companies": [ "3adbdb18-ff69-4650-8717-421e4f3f1775", "aaee37b8-4440-46d4-9efe-d141a7953e26" ], "Groups": [ "9d149260-0535-48f4-8216-deb11ab8016d", "b5f598a5-c23d-4da8-88c7-174483e3121f" ], "Opportunities": [ "7251f71e-32bb-4328-9050-0839708facc6", "dc052a8e-2975-4bdc-a6aa-de78af13d36a" ] } }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.