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": "aca707f9-008c-4be8-84d0-5c6ef264f589", "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-15T17:58:01Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "becd1594-9bb5-4487-873c-9eba4d28e591", "EditDate": "2024-05-15T17:58:01Z", "CreateDate": "2024-05-15T17:58:01Z", "StartTime": "2024-05-15T17:58:01Z", "EndTime": "2024-05-15T17:58:01Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "fe931b02-580e-4251-8f5c-ed5147741080", "b64cbc10-db5d-4227-8f3c-7f88c01dd463" ], "Companies": [ "0c3b7219-f918-4cea-a063-1af0b53aae24", "8df0b9bd-75c6-4cce-900d-7c1d5c5c4ee8" ], "Groups": [ "488d2859-7de1-449f-a675-06d694542560", "b6a53bc2-34b0-468d-9ced-7b010c03b173" ], "Opportunities": [ "a3d7aef8-f58b-45a5-8280-779688068480", "cddb3a98-c86a-4877-80eb-0d76b79b3409" ] } }
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:
"eb29b380-a979-4a16-a32a-3f059763da0a"