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": "7bfd722b-1747-495d-8141-2bb1b0451cc5",
  "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-03-02T17:29:22Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "IsPrivate": true,
  "ManageUserId": "18c81e76-4c67-4084-96e8-4b403ea7ec62",
  "EditDate": "2026-03-02T17:29:22Z",
  "CreateDate": "2026-03-02T17:29:22Z",
  "StartTime": "2026-03-02T17:29:22Z",
  "EndTime": "2026-03-02T17:29:22Z",
  "Details": "sample string 12",
  "LinkedEntities": {
    "Contacts": [
      "1de914b0-7882-4839-9c94-e008b0bf93d3",
      "07680f51-1b9e-49ed-9a34-233defcc2b45"
    ],
    "Companies": [
      "81efb806-82e7-4567-900d-19d71d798845",
      "2519496b-7ca3-4995-a05c-712028c1efdc"
    ],
    "Groups": [
      "b2c6e5bc-a582-4311-b94d-71c2c01d5580",
      "57712379-24ee-4431-86a8-1f127c0a2097"
    ],
    "Opportunities": [
      "648acf7d-7dc1-4842-a0af-abbc6114d1c6",
      "f95194aa-5a89-4777-b8ae-0963385841f0"
    ]
  }
}

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:
"70b11ff2-c4af-4efa-9c6b-5b7e10cdee77"