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": "da3fc499-92c4-44dd-8a99-27d8f67ce00b", "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-07-05T09:23:26Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "7b6c7daa-f000-4669-97a0-ef25bcfca2ef", "EditDate": "2025-07-05T09:23:26Z", "CreateDate": "2025-07-05T09:23:26Z", "StartTime": "2025-07-05T09:23:26Z", "EndTime": "2025-07-05T09:23:26Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "9391d9e4-8217-484d-b98e-589136a3316a", "cb21b9ee-f98f-4627-ae61-a251529df40f" ], "Companies": [ "e8319017-9328-430f-994f-ce95fb5bce6b", "faab2f9a-f175-4fb3-8071-56ec9abdca17" ], "Groups": [ "cce8d983-2e86-4c40-a19d-42fd631defdf", "8d3dc44d-eb64-4157-90aa-2c543365f502" ], "Opportunities": [ "cd2d2e88-42af-4501-a270-d910d5ca4ccb", "1b01b2fb-edee-474e-949f-58fa9461ed01" ] } }
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:
"04879fb2-c52e-430e-8892-08a19d7cdf33"