CalendarList: patch
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Atualiza uma agenda na lista de agendas do usuário. Esse método é compatível com a semântica de patch. Cada solicitação de patch consome três unidades de cota. Use um get seguido de um update. Os valores de campo especificados substituem os valores atuais. Os campos que você não especificar na solicitação permanecem inalterados. Os campos de matriz, se especificados, substituem as matrizes atuais. Isso descarta todos os elementos de matriz anteriores.
Teste agora.
Solicitação
Solicitação HTTP
PATCH https://www.googleapis.com/calendar/v3/users/me/calendarList/calendarId
Parâmetros
| Nome do parâmetro |
Valor |
Descrição |
| Parâmetros de caminho |
calendarId |
string |
Identificador da agenda. Para extrair os IDs de agenda, chame o método calendarList.list. Se você quiser acessar a agenda principal do usuário conectado, use a palavra-chave primary.
|
| Parâmetros de consulta opcionais |
colorRgbFormat |
boolean |
Define se os campos foregroundColor e backgroundColor vão ser usados para gravar as cores do calendário (RGB). Se esse recurso for usado, o campo colorId baseado em índice será definido automaticamente como a melhor opção correspondente. Opcional. O valor padrão é falso.
|
Autorização
Esta solicitação requer autorização com pelo menos um dos seguintes escopos:
| Escopo |
|---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.calendarlist |
Para mais informações, consulte a página de autenticação e autorização.
Corpo da solicitação
No corpo da solicitação, informe as partes relevantes de um recurso CalendarList, de acordo com as regras de semântica de patch.
Confira!
Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[],[],null,["# CalendarList: patch\n\n| **Note:** Requires [authorization](#auth).\n\nUpdates an existing calendar on the user's calendar list. This method supports patch semantics. Note that each patch request consumes three quota units; prefer using a `get` followed by an `update`. The field values you specify replace the existing values. Fields that you don't specify in the request remain unchanged. Array fields, if specified, overwrite the existing arrays; this discards any previous array elements.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP request\n\n```\nPATCH https://www.googleapis.com/calendar/v3/users/me/calendarList/calendarId\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Path parameters** |||\n| `calendarId` | `string` | Calendar identifier. To retrieve calendar IDs call the [calendarList.list](/workspace/calendar/api/v3/reference/calendarList/list) method. If you want to access the primary calendar of the currently logged in user, use the \"`primary`\" keyword. |\n| **Optional query parameters** |||\n| `colorRgbFormat` | `boolean` | Whether to use the `foregroundColor` and `backgroundColor` fields to write the calendar colors (RGB). If this feature is used, the index-based `colorId` field will be set to the best matching option automatically. Optional. The default is False. |\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes:\n\n| Scope |\n|---------------------------------------------------------|\n| `https://www.googleapis.com/auth/calendar` |\n| `https://www.googleapis.com/auth/calendar.app.created` |\n| `https://www.googleapis.com/auth/calendar.calendarlist` |\n\nFor more information, see the [authentication and authorization](/workspace/guides/configure-oauth-consent) page.\n\n### Request body\n\nIn the request body, supply the relevant portions of a [CalendarList resource](/workspace/calendar/api/v3/reference/calendarList#resource), according to the rules of patch semantics.\n\nResponse\n--------\n\nIf successful, this method returns a [CalendarList resource](/workspace/calendar/api/v3/reference/calendarList#resource) in the response body.\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response."]]
