Method: accounts.homepage.claim
Stay organized with collections
Save and categorize content based on your preferences.
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:
- 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
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
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.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/content
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-06 UTC.
[null,null,["Last updated 2025-06-06 UTC."],[[["\u003cp\u003eClaims a store's homepage, requiring admin access and potentially re-verifying ownership.\u003c/p\u003e\n"],["\u003cp\u003eSends a POST request to the specified URL with optional overwrite parameter in the request body.\u003c/p\u003e\n"],["\u003cp\u003eReturns the homepage details upon success or an error if permissions are insufficient or claiming fails.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/content\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],["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"],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/v1beta/{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_v1beta/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)."]]
