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": "3ac1898d-4d4d-452b-9405-734d3f793f12",
"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-02-28T22:44:59Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "8d01d3c0-c5af-4a62-a483-31d06574e092",
"EditDate": "2026-02-28T22:44:59Z",
"CreateDate": "2026-02-28T22:44:59Z",
"StartTime": "2026-02-28T22:44:59Z",
"EndTime": "2026-02-28T22:44:59Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"5edcd415-2a6a-47b3-9b1d-22ae70aaeece",
"c02e353c-76e5-40a6-a3ac-bfcaf92520db"
],
"Companies": [
"e04b9e14-2ab1-4d8c-928c-f2d144a4df9b",
"9c87d359-5a41-429d-ab70-c3a05e0e0e7c"
],
"Groups": [
"bb6f302d-e077-467e-a166-5fded07b9d52",
"e7301d21-57a4-4f63-8eb5-f726e0126634"
],
"Opportunities": [
"1040d28a-569e-4d43-bb05-1d444a5e81b9",
"45662d6e-1a78-4813-9f38-0a3144509765"
]
}
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.