Method: networks.sites.batchUpdate

  • The batchUpdate method allows for updating multiple Site objects via a single API request.

  • A POST request is used, targeting the /v1/{parent}/sites:batchUpdate endpoint.

  • The request body includes a list of UpdateSiteRequest objects, each specifying a Site object and an updateMask to indicate which fields to modify.

  • The response body contains the updated Site objects.

  • Authorization requires the https://www.googleapis.com/auth/admanager OAuth scope.

API to batch update Site objects.

HTTP request

POST https://admanager.googleapis.com/v1/{parent}/sites:batchUpdate

Path parameters

Parameters
parent

string

Required. The parent resource where Sites will be updated. Format: networks/{networkCode} The parent field in the UpdateSiteRequest must match this field.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requests": [
    {
      object (UpdateSiteRequest)
    }
  ]
}
Fields
requests[]

object (UpdateSiteRequest)

Required. The Site objects to update. A maximum of 100 objects can be updated in a batch.

Response body

Response object for sites.batchUpdate method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "sites": [
    {
      object (Site)
    }
  ]
}
Fields
sites[]

object (Site)

The Site objects updated.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/admanager

For more information, see the OAuth 2.0 Overview.

UpdateSiteRequest

Request object for sites.patch method.

JSON representation 
{
  "site": {
    object (Site)
  },
  "updateMask": string
}
Fields
site

object (Site)

Required. The Site to update.

The Site's name is used to identify the Site to update.
updateMask

string (FieldMask format)

Required. The list of fields to update.

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