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": "c871a0ee-7286-4e22-a1d6-f92d78a5c6fe",
"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-10-13T14:08:59Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "78a84999-d4a7-4584-bd3a-fe4a2e11b802",
"EditDate": "2026-10-13T14:08:59Z",
"CreateDate": "2026-10-13T14:08:59Z",
"StartTime": "2026-10-13T14:08:59Z",
"EndTime": "2026-10-13T14:08:59Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"140ff05b-9631-407e-9670-79b6c4c46dea",
"44e19726-c923-488b-9dc0-97cf846af32a"
],
"Companies": [
"82192637-ca64-440d-93fd-83e020410289",
"88ad75ec-1744-493b-ac08-b6868c35c1df"
],
"Groups": [
"11a928d0-56d9-45bd-a13f-3d78aaa74d83",
"59f8b266-418a-4645-b7d6-168d268d3706"
],
"Opportunities": [
"0f3984b9-7512-49b1-86f1-46f3895793a8",
"30cb6f75-c6df-4f06-bb47-59cb03512dc0"
]
}
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.