Events: patch
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Met à jour un événement. Cette méthode est compatible avec la sémantique "patch". Notez que chaque requête de correctif consomme trois unités de quota. Nous vous recommandons d'utiliser un get
suivi d'un update
. Les valeurs de champ que vous spécifiez remplacent les valeurs existantes. Les champs que vous ne spécifiez pas dans la requête restent inchangés. Si spécifiés, les champs de tableau écrasent les tableaux existants. Tous les éléments de tableau précédents sont alors supprimés.
Essayez maintenant.
Requête
Requête HTTP
PATCH https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId
Paramètres
Nom du paramètre |
Valeur |
Description |
Paramètres de chemin d'accès |
calendarId |
string |
Identifiant de l'agenda. Pour récupérer les ID d'agenda, appelez la méthode calendarList.list. Si vous souhaitez accéder à l'agenda principal de l'utilisateur actuellement connecté, utilisez le mot clé "primary ".
|
eventId |
string |
Identifiant de l'événement.
|
Paramètres de requête facultatifs |
alwaysIncludeEmail |
boolean |
Obsolète et ignoré. Une valeur est toujours renvoyée dans le champ email pour l'organisateur, le créateur et les participants, même si aucune adresse e-mail réelle n'est disponible (c'est-à-dire qu'une valeur générée et non fonctionnelle est fournie).
|
conferenceDataVersion |
integer |
Numéro de version des données de conférence compatibles avec le client de l'API. La version 0 ne prend pas en charge les données de conférence et les ignore dans le corps de l'événement. La version 1 permet de copier ConferenceData et de créer des conférences à l'aide du champ createRequest de conferenceData. La valeur par défaut est 0.
Les valeurs autorisées vont de 0 à 1 , inclus.
|
maxAttendees |
integer |
Nombre maximal de participants à inclure dans la réponse. Si le nombre de participants est supérieur au nombre spécifié, seul le participant est renvoyé. Facultatif.
|
sendNotifications |
boolean |
Obsolète. Veuillez utiliser sendUpdates à la place.
Indique si des notifications doivent être envoyées concernant la mise à jour de l'événement (par exemple, en cas de modification de la description, etc.). Notez que certains e-mails peuvent toujours être envoyés, même si vous définissez la valeur sur false . La valeur par défaut est false .
|
sendUpdates |
string |
Les invités qui doivent recevoir des notifications concernant la mise à jour de l'événement (par exemple, en cas de changement de titre, etc.).
Les valeurs acceptées sont les suivantes :
- "
all ": les notifications sont envoyées à tous les invités.
- "
externalOnly ": les notifications ne sont envoyées qu'aux invités qui n'utilisent pas Google Agenda.
- "
none ": aucune notification n'est envoyée. Pour les tâches de migration d'agenda, nous vous conseillons d'utiliser plutôt la méthode Events.import.
|
supportsAttachments |
boolean |
Indique si le client API effectuant l'opération accepte les pièces jointes d'événements. Facultatif. La valeur par défaut est "False" (faux).
|
Autorisation
Cette requête nécessite une autorisation avec au moins l'un des champs d'application suivants:
Portée |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.events.owned |
Pour en savoir plus, consultez la page Authentification et autorisation.
Corps de la requête
Dans le corps de la requête, fournissez les parties pertinentes d'une ressource "Events", conformément aux règles de sémantique de la modification.
Réponse
Si la requête aboutit, cette méthode renvoie une ressource "Events" dans le corps de la réponse.
Essayer
Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[],[],null,["# Events: patch\n\n| **Note:** Requires [authorization](#auth).\n\nUpdates an event. 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/calendars/calendarId/events/eventId\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| `eventId` | `string` | Event identifier. |\n| **Optional query parameters** |||\n| `alwaysIncludeEmail` | `boolean` | Deprecated and ignored. A value will always be returned in the `email` field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided). |\n| `conferenceDataVersion` | `integer` | Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. Acceptable values are `0` to `1`, inclusive. |\n| `maxAttendees` | `integer` | The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. |\n| `sendNotifications` | `boolean` | Deprecated. Please use [sendUpdates](/workspace/calendar/api/v3/reference/events/update#sendUpdates) instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to `false`. The default is `false`. |\n| `sendUpdates` | `string` | Guests who should receive notifications about the event update (for example, title changes, etc.). \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`all`\": Notifications are sent to all guests. - \"`externalOnly`\": Notifications are sent to non-Google Calendar guests only. - \"`none`\": No notifications are sent. For calendar migration tasks, consider using the [Events.import](/workspace/calendar/api/v3/reference/events/import) method instead. |\n| `supportsAttachments` | `boolean` | Whether API client performing operation supports event attachments. 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.events` |\n| `https://www.googleapis.com/auth/calendar.app.created` |\n| `https://www.googleapis.com/auth/calendar.events.owned` |\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 an [Events resource](/workspace/calendar/api/v3/reference/events#resource), according to the rules of patch semantics.\n\nResponse\n--------\n\nIf successful, this method returns an [Events resource](/workspace/calendar/api/v3/reference/events#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."]]