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

History

Name	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": "df1b1557-c420-4b78-9be4-1481380926fb",
  "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-19T00:58:29Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "IsPrivate": true,
  "ManageUserId": "c3d5a647-fb7b-4c17-9b67-bb6ab3463a21",
  "EditDate": "2024-05-19T00:58:29Z",
  "CreateDate": "2024-05-19T00:58:29Z",
  "StartTime": "2024-05-19T00:58:29Z",
  "EndTime": "2024-05-19T00:58:29Z",
  "Details": "sample string 12",
  "LinkedEntities": {
    "Contacts": [
      "eadf158b-5547-410f-84eb-ba8fce3aa98f",
      "b6bea5c5-39b2-4e84-b743-0e554cd8cadb"
    ],
    "Companies": [
      "996875d3-4342-4768-adff-f2967b3990de",
      "dc0c2a9f-c7d3-4c13-834b-605d9c258f68"
    ],
    "Groups": [
      "16915eb5-2010-4870-9054-a10a3fe61e83",
      "90c94a12-0895-4aae-b48a-7b33c6cd293b"
    ],
    "Opportunities": [
      "351c418a-0e71-4b4d-83b8-94d4350036f2",
      "5124c737-10e1-47e0-b1bc-f515843a9cab"
    ]
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the Id of the history record

globally unique identifier

Response Formats

application/json, text/json

Sample:

"d95af958-b315-4e0d-822b-e69e00bdc872"