Claims a store's homepage. Executing this method requires admin access.
If the homepage is already claimed, this will recheck the verification (unless the business is exempted from claiming, which also exempts from verification) and return a successful response. If ownership can no longer be verified, it will return an error, but it won't clear the claim.
In case of failure, a canonical error message is returned:
PERMISSION_DENIED: User doesn't have the necessary permissions on this Merchant Center account.
FAILED_PRECONDITION:
- The account is not a Merchant Center account.
- Merchant Center account doesn't have a homepage.
- Claiming failed (in this case the error message contains more
details).
HTTP request
POST https://merchantapi.googleapis.com/accounts/v1beta/{name=accounts/*/homepage}:claim
Required. The name of the homepage to claim. Format: accounts/{account}/homepage
Request body
The request body contains data with the following structure:
JSON representation
{"overwrite": boolean}
Fields
overwrite
boolean
Optional. When set to true, this option removes any existing claim on the requested website from any other account to the account making the request, effectively replacing the previous claim.
Response body
If successful, the response body contains an instance of Homepage.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-06 UTC."],[[["Claims a store's homepage, requiring admin access and potentially re-verifying ownership."],["Sends a POST request to the specified URL with optional overwrite parameter in the request body."],["Returns the homepage details upon success or an error if permissions are insufficient or claiming fails."],["Requires the `https://www.googleapis.com/auth/content` OAuth scope for authorization."]]],["This content outlines how to claim a store's homepage via an API. A `POST` request to `https://merchantapi.googleapis.com/accounts/v1beta/{name=accounts/*/homepage}:claim` is made, requiring admin access and the `https://www.googleapis.com/auth/content` OAuth scope. The request body can include an optional `overwrite` boolean. Success returns a `Homepage` instance; failure yields `PERMISSION_DENIED` or `FAILED_PRECONDITION` errors. The `name` path parameter specifies the target homepage.\n"]]
