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": "2be2b94f-4a52-40c2-b3f5-ef44489d18c4", "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-08-21T15:37:41Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "7d62e408-99c7-4e8f-9af0-86d9106d7285", "EditDate": "2025-08-21T15:37:41Z", "CreateDate": "2025-08-21T15:37:41Z", "StartTime": "2025-08-21T15:37:41Z", "EndTime": "2025-08-21T15:37:41Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "1663ad52-7a63-468e-b4bb-78efa567943d", "9705769b-6efd-47e2-8b70-85d35cc8e177" ], "Companies": [ "68038d4e-1dae-4529-ab31-7fef227acd82", "43612491-6aac-438d-98d8-6f1f983e967f" ], "Groups": [ "8d90cf5b-4ebc-4307-8ed2-ca9425f3cd50", "ae3fece2-2e5c-4f44-8903-55e8c9d37d46" ], "Opportunities": [ "4ef52be5-f9f1-4744-afcb-56321c3ba099", "d7d21e50-7e16-4ec2-8c5a-d40005915051" ] } }
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:
"b437fad7-1379-4138-8021-5dc19881d6ef"