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": "bab3601d-aaee-4256-8102-6a2efdfc3b03",
"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-01-14T05:13:42Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "028739d8-2064-493b-8c7c-ff3da2e123fe",
"EditDate": "2026-01-14T05:13:42Z",
"CreateDate": "2026-01-14T05:13:42Z",
"StartTime": "2026-01-14T05:13:42Z",
"EndTime": "2026-01-14T05:13:42Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"2b488037-8acb-40f7-8723-0b3b7e8a7dc5",
"0d379d1f-87f4-41df-833c-9e1616efb062"
],
"Companies": [
"f4c6a40f-deb5-4db3-86c2-5c17586b0a42",
"d6dab621-3950-468d-a2f7-99c646d2be55"
],
"Groups": [
"41f8a83f-d703-4e8e-8cb4-e713a4bd4fdb",
"7461817e-dde3-44e3-bbfd-8ddecf602552"
],
"Opportunities": [
"0226eb8c-d308-4246-9b0a-a42112239eea",
"a4c9b46b-7d41-4aba-bad8-1705abf0ef2c"
]
}
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.