NYnylas
Events

Delete an event

Changed on

Delete the specified event.

Google sends deleted events to the "Trash" folder, and you can read them for a period of time using the show_cancelled query parameter.

Microsoft deletes events immediately.

delete/v3/grants/{grant_id}/events/{event_id}

Request

  • Base URL
    https://api.us.nylas.com
  • Auth
    • HTTP bearer
    • or HTTP bearer

Query parameters

calendar_idstring required

The calendar ID of the event.

For Microsoft, we do not validate whether the given calendar ID matches the real calendar ID of the event. This is due to a limitation of the Microsoft Graph API.

(Not supported for iCloud) You can use primary to query the user's primary calendar.

For an Agent Account, you can also pass the account's own email address, in any letter case, to query its primary calendar. Any other email address returns a 400 error.

notify_participantsboolean

When true, the provider emails participants about the change. Set to false to make the change without notifying participants.

Microsoft returns a 400 error for notify_participants=false. iCloud ignores the setting and always notifies participants.

Response

Delete Succeeded

request_idstring required

ID of the request.

Example response

{
  "request_id": "5967ca40-a2d8-4ee0-a0e0-6f18ace39a90"
}

Changes