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": "88965cfb-2b63-402f-92c3-3ee0f7ecbd4b",
"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-03-02T17:27:17Z",
"FileType": "sample string 4",
"FileExtension": "sample string 5",
"FileName": "sample string 6",
"Personal": true,
"Shortcut": true
},
"IsPrivate": true,
"ManageUserId": "099c5f8d-ae0e-4dc2-9d16-113e3a4891fe",
"EditDate": "2026-03-02T17:27:17Z",
"CreateDate": "2026-03-02T17:27:17Z",
"StartTime": "2026-03-02T17:27:17Z",
"EndTime": "2026-03-02T17:27:17Z",
"Details": "sample string 12",
"LinkedEntities": {
"Contacts": [
"348a1af7-5a5f-4023-bee2-06deabbf8650",
"a3f02a15-7dbd-499b-81e2-bcac1d6c45c2"
],
"Companies": [
"6fe869de-26d7-473c-9e75-032dfdf02b41",
"e091f1d1-3855-4b55-84bc-d203a1ba6bd8"
],
"Groups": [
"73c23f07-1b21-4c60-9d82-65d2522edfe1",
"a1cbf147-58f9-4f8c-82e4-c2805c32c1ab"
],
"Opportunities": [
"0c6553fd-2a9d-48f0-8f05-d56972770ead",
"8da9b767-bb88-4161-bfec-d5ad55c6bb50"
]
}
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.