ONontraport
CalendarEvents

Delete a Calendar event

Delete a Calendar event.

####ObjectID: 160#### This is the ID of the Object. It can be used in generic object calls, or in places that need the objectID param.

delete/CalendarEvent

Request

  • Base URL
    https://api.ontraport.com/1
  • Auth
    none declared

Query parameters

idstring required

The id of the event instance to be deleted. Will be in the form of a composite id: e.g. If the event is a single event with an id of 1, the composite id will be 1_0. If it is a recurring event with an id of 2, the composite id will be 2_{timestamp}

edit_scopeinteger

For recurring events, the scope of the recurrences to be deleted.

Integer codes are mapped as follows:

0 => This event

1 => This and following events

2 => All events

Default is all events.

notify_event_guestsinteger

Binary flag to indicate whether or not system generated event cancelation email should be sent to guests.

Response

Successfully deleted event

codeinteger required
dataobject required
account_idinteger required

Changes

No recorded changes to this operation across all 5 revisions of this API.