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": "56f6e01c-7c28-44b9-8f2e-c6d587162b8d", "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-18T15:55:39Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "e90a178b-55a3-4f60-b2b5-73e8f032d9c5", "EditDate": "2025-10-18T15:55:39Z", "CreateDate": "2025-10-18T15:55:39Z", "StartTime": "2025-10-18T15:55:39Z", "EndTime": "2025-10-18T15:55:39Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "5ca102cc-c3a7-4463-b238-27690def3fb3", "d70d52d5-fcc5-4ea6-b159-5154a66234c4" ], "Companies": [ "6f76d181-3690-4ea8-b046-9409ed32adda", "737703db-e48d-43e4-bd29-f8c4d4e542d2" ], "Groups": [ "1289767c-7443-41d2-9db4-08dba562226d", "8cb36cdb-d6e8-4bd2-b717-21668491081e" ], "Opportunities": [ "eeaba2f4-b78a-428e-a198-81c1bbc3b4f7", "abdc829a-7d31-4bab-b6aa-eb1745d3f50f" ] } }
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:
"69c32346-8ae8-4818-9bb6-d4f4f2b8e746"