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": "55c374fb-0117-4a8a-8241-052f050c723f", "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-04T10:16:12Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "10db94ea-5eda-4d0a-bf5e-09eb491d4be0", "EditDate": "2024-05-04T10:16:12Z", "CreateDate": "2024-05-04T10:16:12Z", "StartTime": "2024-05-04T10:16:12Z", "EndTime": "2024-05-04T10:16:12Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "2d209c41-31c8-43b8-8c5e-6c207e4c8020", "e3cf3dee-2d93-4b4a-b872-7d7c34c6b122" ], "Companies": [ "c9c8a25e-0b85-47bb-abbf-ddd385b7e77a", "fb22c9b5-a67d-42e8-995b-4563115edb6f" ], "Groups": [ "74c385c8-c016-488e-a18b-a26da49387eb", "b89742fb-e616-44b9-9fe7-d6f06dc14db9" ], "Opportunities": [ "78b56e7e-b495-4c88-91d3-e054e75a63bd", "635fadf7-ce57-4691-adb6-1ff8ef89ed57" ] } }
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:
"61472104-6dd7-49e8-a65f-9eb01cfd51dd"