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": "b74452c0-29ee-4177-a21e-665b571e38a2", "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-04T14:43:42Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "a32b80df-08af-4391-98d9-145aa552e9a1", "EditDate": "2024-05-04T14:43:42Z", "CreateDate": "2024-05-04T14:43:42Z", "StartTime": "2024-05-04T14:43:42Z", "EndTime": "2024-05-04T14:43:42Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "a5926682-93b9-4888-9998-ab123edb0730", "98ebed4a-9fc5-47b8-9bce-60b6b6f4a7fc" ], "Companies": [ "e422e563-e41f-43d8-8431-67670c84b0af", "ccad9ceb-da7c-45f1-8d21-72403a8c218f" ], "Groups": [ "0f2cea13-c315-4a4a-b49d-c8ed93ea8ad5", "e982cc0c-5096-4f58-8b0b-c779d29353e7" ], "Opportunities": [ "c8b07cfe-1033-4387-b67f-668fd6d0feb0", "b3c11325-5910-4134-b2ce-bde321c6f2d6" ] } }
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:
"e2c86e5a-9d37-4e15-8154-084e7cea60f9"