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/v1/{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-07-31 UTC."],[],[],null,["# Method: accounts.homepage.claim\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nClaims a store's homepage. Executing this method requires admin access.\n\nIf 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.\n\nIn case of failure, a canonical error message is returned:\n\n- PERMISSION_DENIED: User doesn't have the necessary permissions on this Merchant Center account.\n\n- FAILED_PRECONDITION:\n\n - The account is not a Merchant Center account.\n\n - Merchant Center account doesn't have a homepage.\n\n - Claiming failed (in this case the error message contains more\n details).\n\n### HTTP request\n\n`POST https://merchantapi.googleapis.com/accounts/v1/{name=accounts/*/homepage}:claim`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|---------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The name of the homepage to claim. Format: `accounts/{account}/homepage` |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------|\n| ``` { \"overwrite\": boolean } ``` |\n\n| Fields ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Homepage](/merchant/api/reference/rest/accounts_v1/accounts.homepage#Homepage).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
