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": "c16bb2d6-6a15-42fc-ab5e-e856b960b836",
  "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-06-02T13:09:53Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "IsPrivate": true,
  "ManageUserId": "10fa842a-971f-4c8e-9fb3-662eaee597b6",
  "EditDate": "2025-06-02T13:09:53Z",
  "CreateDate": "2025-06-02T13:09:53Z",
  "StartTime": "2025-06-02T13:09:53Z",
  "EndTime": "2025-06-02T13:09:53Z",
  "Details": "sample string 12",
  "LinkedEntities": {
    "Contacts": [
      "cbe4c643-7049-4574-a62f-2bca0f6edf68",
      "a0d3f7d9-278f-41b4-ae33-a927f1075f35"
    ],
    "Companies": [
      "2add5399-54da-4757-8eee-8e8cacf28bed",
      "f91c5d1e-a6c4-4a00-81c1-509d03790780"
    ],
    "Groups": [
      "c37af8f5-1240-442f-be53-942c856a6fa7",
      "9a790ac9-9174-491f-aa5a-9de6608a91e1"
    ],
    "Opportunities": [
      "812822cf-eba4-4588-a9f0-6c521e02d5a2",
      "3632752b-1176-4b72-b788-5b568c16bac4"
    ]
  }
}

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:
"8abe1afa-5515-4b6b-ad38-1d092e1c7bfb"