Method: projects.snoozes.patch

Updates a Snooze, identified by its name, with the parameters in the given Snooze object.

HTTP request


Path parameters



Required. Identifier. The name of the Snooze. The format is:


The ID of the Snooze will be generated by the system.

Query parameters


string (FieldMask format)

Required. The fields to update.

For each field listed in updateMask:

  • If the Snooze object supplied in the UpdateSnoozeRequest has a value for that field, the value of the field in the existing Snooze will be set to the value of the field in the supplied Snooze.
  • If the field does not have a value in the supplied Snooze, the field in the existing Snooze is set to its default value.

Fields not listed retain their existing value.

The following are the field names that are accepted in updateMask:

  • displayName
  • interval.start_time
  • interval.end_time

That said, the start time and end time of the Snooze determines which fields can legally be updated. Before attempting an update, users should consult the documentation for UpdateSnoozeRequest, which talks about which fields can be updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Snooze.

Response body

If successful, the response body contains an instance of Snooze.

Authorization scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.