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": "c21ac195-4fac-4ceb-9b2e-5632e823d088",
"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-07-01T00:01:09Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "e1018907-cfe8-4465-8953-6c11db6d7147",
"EditDate": "2026-07-01T00:01:09Z",
"CreateDate": "2026-07-01T00:01:09Z",
"StartTime": "2026-07-01T00:01:09Z",
"EndTime": "2026-07-01T00:01:09Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"30ba7b7a-4d38-4635-9b95-7a5b8e75137e",
"90fc8678-314e-4541-914e-0dcf913490f8"
],
"Companies": [
"1f0f486f-3b7d-4b97-97bb-d74570ef22d3",
"c7e791d7-41c7-4afa-9d37-78c2602a94e0"
],
"Groups": [
"fd925cad-d3f4-48e5-8853-367e6f43e561",
"3e50452a-5f2e-42b9-9546-2e26d1995a8c"
],
"Opportunities": [
"738dbd35-0334-477e-b488-0c658e0546dd",
"fde916b8-4a67-4d68-9efc-a9391d84928d"
]
}
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.