Method: accounts.businessIdentity.updateBusinessIdentity

AI-generated Key Takeaways

• This operation updates the business identity of an account, requiring admin access and using a PATCH request to a specific URL structure.

• The request involves path and query parameters, with the path parameter identifying the business identity and query parameter specifying update fields.

• Request and response bodies both utilize the BusinessIdentity object for data transfer.

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

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization scopes
• Try it!

Updates the business identity of an account. Executing this method requires admin access.

HTTP request

PATCH https://merchantapi.googleapis.com/accounts/v1beta/{businessIdentity.name=accounts/*/businessIdentity}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
businessIdentity.name	string Identifier. The resource name of the business identity. Format: accounts/{account}/businessIdentity

Query parameters

Parameters
updateMask	string (FieldMask format) Optional. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase): blackOwned latinoOwned promotionsConsent smallBusiness veteranOwned womenOwned

Request body

The request body contains an instance of BusinessIdentity.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.