Delete Event

Description

Deletes an event from a user’s calendar.

URL format

api.cronofy.com/v1/calendars/{calendar_id}/events

Example Request

DELETE /v1/calendars/cal_n23kjnwrw2_jsdfjksn234/events HTTP/1.1
Host: api.cronofy.com
Authorization: Bearer {ACCESS_TOKEN}
Content-Type: application/json; charset=utf-8

{
  "event_id": "qTtZdczOccgaPncGJaCiLg"
}

Example Response

HTTP/1.1 202 Accepted

Request parameters

calendar_id required  #

The calendar_id of the calendar you wish the event to be removed from. This ID should have been discovered by making a list calendars request and must not have a calendar_readonly value that is true.

event_id required  #

The String that uniquely identifies the event. The combination of calendar_id and event_id combination will be used to delete the event.

Usually this will be your own internal ID for the event, encoded as a String.

include_userinfo optional  #

A Boolean specifying whether the response should include an embedded userinfo response.

Response parameters

This request has no response body unless include_userinfo was specified, in which case it will include an embedded userinfo response under a userinfo parameter.

Error responses

401 Unauthorized #

The request was refused as the provided authentication credentials were not recognized.

When an OAuth refresh_token is available then it should be used to request a replacement auth_token before the request is retried.

403 Forbidden #

The request was refused as the provided authorization credentials were recognized but does not grant the read_free_busy scope which was required for the request.

You will need to make an additional authorization request including the read_free_busy scope before retrying the request.

Note that the read_events scope implicitly includes this scope as it allows access to a higher level of information than free-busy so you do not have to request both.

422 Unprocessable #

The request was unable to be processed due to it containing invalid parameters.

The response will contain a JSON object containing one or more errors relating to the invalid parameters.

For example, if you omitted the required tzid parameter, you would receive a response like:

{
  "errors": {
    "tzid": [
      {
        "key": "errors.required",
        "description": "required"
      }
    ]
  }
}

The key field is intended for programmatic use and the description field is a human-readable equivalent.

Search