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": "7c16aa0e-3af4-4157-95c1-990bac54c8c2",
  "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": "2025-09-02T20:36:06Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "IsPrivate": true,
  "ManageUserId": "02c45ea4-f70f-4410-8a38-753594988b71",
  "EditDate": "2025-09-02T20:36:06Z",
  "CreateDate": "2025-09-02T20:36:06Z",
  "StartTime": "2025-09-02T20:36:06Z",
  "EndTime": "2025-09-02T20:36:06Z",
  "Details": "sample string 12",
  "LinkedEntities": {
    "Contacts": [
      "d212fc83-b609-4a5b-bd32-0a7a035368be",
      "a92f9b95-1460-467e-9d47-ecbc0242f924"
    ],
    "Companies": [
      "43c7e369-417e-4532-aa5c-f7d1f42fb28f",
      "4dbbd907-f0c0-4733-bb47-158f5ddd237d"
    ],
    "Groups": [
      "c23bf730-3c8c-4ee3-8536-05e87c79d70c",
      "758dff3d-fc9e-462c-bbef-4fdd82f42902"
    ],
    "Opportunities": [
      "e345afad-75b0-42f2-9994-8d664361d3cb",
      "dc0c6b16-356c-49a1-8f8e-6924f959de13"
    ]
  }
}

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:
"65c6d377-a581-4ad2-a164-161e64a6e2ee"