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": "742cbab2-fe25-415e-aee6-943bd36b21fa", "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-08T01:11:41Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "33831107-028d-4c57-8d7d-1c9d7fcf841a", "EditDate": "2024-05-08T01:11:41Z", "CreateDate": "2024-05-08T01:11:41Z", "StartTime": "2024-05-08T01:11:41Z", "EndTime": "2024-05-08T01:11:41Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "d015b96a-0806-4ee9-ac47-3ff0d439e96a", "99eb3a03-8fdc-4f4f-a107-569a017b01e9" ], "Companies": [ "4f3b2a8a-ff76-4f64-bd58-92812dcf8fc7", "898518be-e862-4b91-a39a-15fe88df8efb" ], "Groups": [ "fc4caccb-d23c-411e-8106-4acebca792e7", "e3aac4e5-3c9f-496e-9767-29b4a8ef38e9" ], "Opportunities": [ "6cb3fb73-85ef-45e7-a2f7-0b3f9d23c810", "e1af423e-ec54-480b-82c7-1fff7af59016" ] } }
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:
"87a4a3d5-f2c5-47b1-99a5-6776209f5d0d"