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": "6dcf65c7-1eff-43a7-a9a2-bd2554d98394",
  "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-12-31T18:48:33Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "IsPrivate": true,
  "ManageUserId": "0e40b751-5031-4798-811f-8d38494eb01b",
  "EditDate": "2025-12-31T18:48:33Z",
  "CreateDate": "2025-12-31T18:48:33Z",
  "StartTime": "2025-12-31T18:48:33Z",
  "EndTime": "2025-12-31T18:48:33Z",
  "Details": "sample string 12",
  "LinkedEntities": {
    "Contacts": [
      "72e5c2f1-9c39-431f-bd3c-b77de20438ad",
      "ac1d9992-f4cd-4e50-8fc8-f94f10fea4dc"
    ],
    "Companies": [
      "69485eda-a302-4a01-9f0b-eb0fda230ddf",
      "812303b2-b543-45c4-9ca7-0b2402a8adfe"
    ],
    "Groups": [
      "ad622a39-983f-4873-b838-ce559d093800",
      "9729900e-5568-4bff-9d2c-2001872660a6"
    ],
    "Opportunities": [
      "f5a1c736-c0cf-40d6-824f-61933dbac880",
      "f1766b9d-ffd9-416d-a662-6b36aaf2e06a"
    ]
  }
}

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:
"96962ef1-f6c7-4cfd-ada8-2a991643581f"