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": "205c824d-ba66-400a-8447-f3b7d3b4b6e7", "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-07T15:05:32Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "9e2762fe-d62e-43a0-bcef-a7f2b4204687", "EditDate": "2024-05-07T15:05:32Z", "CreateDate": "2024-05-07T15:05:32Z", "StartTime": "2024-05-07T15:05:32Z", "EndTime": "2024-05-07T15:05:32Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "7701279b-ce4a-44f2-82d2-a7c68e464bfb", "a3ff9540-22a5-4bf6-bb71-b6ade93e68f0" ], "Companies": [ "2740672e-bf97-48df-aba9-c1d276575fd0", "d8f3754a-ad86-4922-839f-67a108b58a8f" ], "Groups": [ "2df74737-dc7d-4ffa-abf5-a9c67dc6a5c9", "c91f4dd3-ffaa-469b-83f2-3c655ac76e3b" ], "Opportunities": [ "1d64fdc7-80bd-411c-afd9-f5f8d7a83513", "734a11ba-447e-46d7-a750-cf3a3222547c" ] } }
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:
"31bcce66-793a-4428-a9d2-d6bcf92d73d4"