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

NameDescriptionTypeAdditional information
id

Activity ID

globally unique identifier

Required

Body Parameters

Serialized Activity record in the body of the request

History
NameDescriptionTypeAdditional 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": "e9e6ebea-75d9-48c1-bc80-561406953ad9",
  "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": "2024-05-04T12:04:02Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "IsPrivate": true,
  "ManageUserId": "69b81801-5970-425f-a59b-3a97969ec0b5",
  "EditDate": "2024-05-04T12:04:02Z",
  "CreateDate": "2024-05-04T12:04:02Z",
  "StartTime": "2024-05-04T12:04:02Z",
  "EndTime": "2024-05-04T12:04:02Z",
  "Details": "sample string 12",
  "LinkedEntities": {
    "Contacts": [
      "18103e91-9794-40b1-b13d-937dff6bd94b",
      "3700b587-55bc-498d-b708-7a6bad4dce93"
    ],
    "Companies": [
      "8c6a4bb9-1f96-47c1-8c2d-2c0c4e4c9cfd",
      "166ec148-4d77-44ca-a1be-2bc91c182dc9"
    ],
    "Groups": [
      "77212f75-bedf-4459-bf80-67c9b9caec82",
      "08ccb410-00f9-459c-9ecc-1a5dca895055"
    ],
    "Opportunities": [
      "6c52a008-8bea-49ab-a18c-97e74cf1e160",
      "7a4786b5-1c5a-419d-bd32-a3e3283a73a7"
    ]
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.