Calendars: clear

Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account. Try it now or see an example.

Request

HTTP request

POST https://www.googleapis.com/calendar/v3/calendars/calendarId/clear

Parameters

Parameter name	Value	Description
Path parameters
`calendarId`	`string`	Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "`primary`" keyword.

Authorization

This request requires authorization with the following scope:

Scope
`https://www.googleapis.com/auth/calendar`

For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.

Examples

Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).

Java

Uses the Java client library.

import com.google.api.services.calendar.Calendar;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Clear a calendar
service.calendars().clear('primary').execute();

Python

Uses the Python client library.

service.calendars().clear('primary').execute()

PHP

Uses the PHP client library.

$service->calendars->clear('primary');

Ruby

Uses the Ruby client library.

result = client.clear_calendar('calendarId')

Try it!

Use the APIs Explorer below to call this method on live data and see the response.