Method: locations.admins.patch

  • This document details the PATCH request to update an Admin for a specific location within a Google My Business account.

  • Only the AdminRole of the Admin can be updated using the updateMask query parameter.

  • The request requires authorization using the https://www.googleapis.com/auth/business.manage scope.

  • Both the request and response bodies utilize the Admin object for data transfer.

  • Location admins are identified using the locations/{locationId}/admins/{admin_id} path parameter format.

Updates the Admin for the specified location. Only the AdminRole of the Admin can be updated.

HTTP request

PATCH https://mybusinessaccountmanagement.googleapis.com/v1/{locationAdmin.name=locations/*/admins/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
locationAdmin.name

string

Immutable. The resource name. For account admins, this is in the form: accounts/{account_id}/admins/{admin_id}

For location admins, this is in the form: locations/{locationId}/admins/{admin_id}

This field will be ignored if set during admin creation.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The specific fields that should be updated. The only editable field is role.

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 Admin.

Response body

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/business.manage

For more information, see the OAuth 2.0 Overview.