Method: locations.patch

  • This documentation outlines how to update a specified location using a PATCH request to the Google My Business Business Information API.

  • The request requires specifying the location's name as a path parameter and utilizes query parameters like updateMask for field-specific updates and validateOnly for request validation.

  • The request body should contain a Location object with the desired updates, and a successful response will return the updated Location object.

  • Authorization for this operation necessitates the https://www.googleapis.com/auth/business.manage OAuth scope.

Updates the specified location.

HTTP request

PATCH https://mybusinessbusinessinformation.googleapis.com/v1/{location.name=locations/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
location.name

string

Google identifier for this location in the form: locations/{locationId}.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The specific fields to update.

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

boolean

Optional. If true, the request is validated without actually updating the location. When this field is set, we will only return validation errors if there were any. The response will be empty if no errors were found.

Request body

The request body contains an instance of Location.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.