DELETE api/activities/clear/{id}?accessorId={accessorId}
Clear an Activity.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Activity Id |
globally unique identifier |
Required |
accessorId |
Accessor Id |
globally unique identifier |
Required |
Body Parameters
The history record that will be created
HistoryName | 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": "9575b93e-c11b-45ea-b4ae-0e276873ae39", "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-19T00:02:20Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "6e136db3-2c3b-4043-b665-236576129265", "EditDate": "2024-05-19T00:02:20Z", "CreateDate": "2024-05-19T00:02:20Z", "StartTime": "2024-05-19T00:02:20Z", "EndTime": "2024-05-19T00:02:20Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "2c9210e2-3742-42b2-8ed3-d92272227984", "080fe49a-d090-45eb-a760-4dc16fa533cd" ], "Companies": [ "cb3ce0a9-25fe-47af-8fe7-96677bad4019", "320ff96e-31d3-4b88-93e0-0124af96f6a0" ], "Groups": [ "df7f4428-8691-45a6-9d28-5b0ff9d06ace", "1d804e78-6e61-49d2-a7d9-ed8a206dea26" ], "Opportunities": [ "5e23f842-5879-4f2b-bbc1-09e3f23b5c4a", "bba57996-74d7-4e51-95fb-060211a3007f" ] } }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Returns the Id of the history record
globally unique identifierResponse Formats
application/json, text/json
Sample:
"d08af34f-0c13-4a4d-8fe4-6a84983f69f7"