Method: accounts.patch

  • This document details the process for updating a specified business account using the PATCH method with the provided URL, specifically targeting the accountName field.

  • The request necessitates specific path and query parameters, including account.name for account identification and updateMask to specify the fields for modification.

  • It requires the use of an Account object in both the request and response bodies, along with authorization using the https://www.googleapis.com/auth/business.manage scope.

  • This method is applicable to business accounts only; personal accounts cannot be updated using this approach, and a validation-only mode can be enabled by setting the validateOnly query parameter.

Updates the specified business account. Personal accounts cannot be updated using this method.

HTTP request

PATCH https://mybusinessaccountmanagement.googleapis.com/v1/{account.name=accounts/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
account.name

string

Immutable. The resource name, in the format accounts/{account_id}.

Query parameters

Parameters
updateMask

string (FieldMask format)

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

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

Request body

The request body contains an instance of Account.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.