DELETE api/activities/clear-recurring/{id}?occurrenceDate={occurrenceDate}
Delete an occurrence of a recurring Activity.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Recurring Activity Id |
globally unique identifier |
Required |
occurrenceDate |
The date of the occurrence. Parameter must be formatted in the K-API default date format. |
string |
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": "42de4605-0c9a-4945-b195-c101ce0f01c2", "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": "2025-10-16T14:56:12Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "52333fb1-5470-45ac-88fb-66ee71639ca9", "EditDate": "2025-10-16T14:56:12Z", "CreateDate": "2025-10-16T14:56:12Z", "StartTime": "2025-10-16T14:56:12Z", "EndTime": "2025-10-16T14:56:12Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "ec48e07c-2dd0-424e-9688-07647da3a443", "82df50b1-e7b9-4629-be68-b9521b4073b8" ], "Companies": [ "68a21893-2f18-41b1-ad7e-c843cb5fff10", "28a90eba-7a1a-4b37-aedf-cd20eadc89e5" ], "Groups": [ "4ff045f0-af5c-4b28-b4d8-d322b44bd111", "cb2e78d7-107b-4c87-bf78-0818d378882b" ], "Opportunities": [ "e5a09a85-7608-46c9-ac14-e40c13a0897f", "1e4c70fb-8062-4c2c-bd84-503c39700cd9" ] } }
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:
"75714be1-f889-4d15-822d-48679cc4ef7c"