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
History| Name | 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": "a33faeaf-f0b5-4968-9714-0af3dddb9817",
"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": "2026-08-29T12:42:59Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "b49b2afc-8962-4a02-a478-c5cee371254a",
"EditDate": "2026-08-29T12:42:59Z",
"CreateDate": "2026-08-29T12:42:59Z",
"StartTime": "2026-08-29T12:42:59Z",
"EndTime": "2026-08-29T12:42:59Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"4bbe351a-8039-4faa-bce7-b5ea20d6cd4d",
"4b4d3ec3-0826-4dd5-af04-312289d724c5"
],
"Companies": [
"fd300be9-54f6-4df5-92d9-2a6076a67cb8",
"c6a4e642-c968-4705-81b6-93f44f9692df"
],
"Groups": [
"0a96dd4b-34d5-4b32-8859-bbf53da18fc1",
"07e90a4f-1607-4cbc-9de8-26e41401e919"
],
"Opportunities": [
"750cb467-4aa0-4ea6-8484-09332efa3a85",
"78947670-eeed-45e2-9139-0ebc67615485"
]
}
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.