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": "5efeb867-7c1c-4b5a-9a3e-42e57946cfe5", "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-15T08:38:44Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "46f7c3ab-a31f-4aee-9e9b-f0713047d924", "EditDate": "2024-05-15T08:38:44Z", "CreateDate": "2024-05-15T08:38:44Z", "StartTime": "2024-05-15T08:38:44Z", "EndTime": "2024-05-15T08:38:44Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "bbe19063-7034-462d-b0a7-41a60df8f53a", "a729f547-39da-419b-9699-81cba41c5cee" ], "Companies": [ "6baa9f15-b327-4a82-964f-679241c117f5", "3b3d1e73-43e5-445e-bcfd-a002b26d2858" ], "Groups": [ "7740add6-158c-4761-9917-5037cb989d8b", "711fec9d-9cab-4bb0-8251-1e0d25038fdc" ], "Opportunities": [ "086d073e-8c00-482a-9c39-6fa63b7e602b", "9cd2039e-f070-4965-8ca3-a186adec8094" ] } }
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:
"c21a442f-cd90-437b-a4f0-043e5ab9e3a1"