Most PATCH
endpoints support partial updates via a combination of a partial entity body and a fields
parameter.
The fields
parameter accepts a set of field paths that specifies the entity data to update. In general, the fields path begins from the root of the request body.
When the fields
parameter contains a sub-path of the entity fields, like event
- all nested fields are included in the update: event.title
, event.description
, etc.
When the fields
parameter is empty, the request will modify ALL entity fields.
fields
parameter behavior follows google.protobuf.FieldMask semantics.
To update an Event
title, and reschedule it to a later date, the request would look like this:
1
To erase optional fields, send an empty body and list the field(s) to update in the fields
parameter.
For example, to clear an event description, the request would look like this:
1
When only one parameter can be updated, the fields
parameter must still be passed.
For example, to bulk update the status
of multiple RSVPs to one event, the request would look like this:
1