DELETE api/activities/clear-recurring/{id}?occurrenceDate={occurrenceDate}

Delete an occurrence of a recurring Activity.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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": "d7081f17-13a8-477b-960e-239b5c1e1975",
  "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": "2026-02-28T22:46:47Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "IsPrivate": true,
  "ManageUserId": "384cb493-0b70-4e9c-baab-09d7f3071aa0",
  "EditDate": "2026-02-28T22:46:47Z",
  "CreateDate": "2026-02-28T22:46:47Z",
  "StartTime": "2026-02-28T22:46:47Z",
  "EndTime": "2026-02-28T22:46:47Z",
  "Details": "sample string 12",
  "LinkedEntities": {
    "Contacts": [
      "f2864f68-d70c-4b4c-bd71-68e1a1a21e8a",
      "86e3098f-9e64-493a-84bb-e102bdb75b6b"
    ],
    "Companies": [
      "fde8d758-f556-43ee-ba40-245731df580c",
      "1da0bead-3505-4497-af2c-63d58a3f497b"
    ],
    "Groups": [
      "623ef61b-fc09-47ff-9059-b951e9dd559c",
      "0d801460-0669-4d9e-ac98-2b459f8ecb6d"
    ],
    "Opportunities": [
      "5c82f88c-bddc-4534-9341-f41d64be983e",
      "c0171c26-ab57-4eab-ad57-42f6a5ece2da"
    ]
  }
}

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:
"7129e021-43c9-4402-9ec1-06ca87c15ee1"