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": "31d7c84a-2dff-4b36-b950-73f0973555c4",
  "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-04-15T17:01:26Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "IsPrivate": true,
  "ManageUserId": "710b6b9f-4547-4d84-87ec-7eb93dd95077",
  "EditDate": "2026-04-15T17:01:26Z",
  "CreateDate": "2026-04-15T17:01:26Z",
  "StartTime": "2026-04-15T17:01:26Z",
  "EndTime": "2026-04-15T17:01:26Z",
  "Details": "sample string 12",
  "LinkedEntities": {
    "Contacts": [
      "d173cf23-e10a-495c-bfcf-3fbda78b2c6c",
      "9b8c541f-cf9b-46f3-86b2-42909a4dcad3"
    ],
    "Companies": [
      "a575645f-58ac-4466-b513-96a53e7738e8",
      "c55e8408-9556-4a53-b5a5-e84e256b610e"
    ],
    "Groups": [
      "12a4f8ef-3702-4828-ba9a-df8392ed8470",
      "4a8aa785-2470-4f06-85ec-d46ee6862e9a"
    ],
    "Opportunities": [
      "ab040c18-2231-4bca-951c-c565d90ac028",
      "bf9f0751-eb45-41b6-9c66-377dbf2466db"
    ]
  }
}

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:
"ed572fb7-6075-4912-84c0-5d23142e591a"