Method: accounts.programs.disable
Stay organized with collections
Save and categorize content based on your preferences.
Disable participation in the specified program for the account.
HTTP request
POST https://merchantapi.googleapis.com/accounts/v1beta/{name=accounts/*/programs/*}:disable
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The name of the program for which to disable participation for the given account. Format: accounts/{account}/programs/{program}. For example, accounts/123456/programs/free-listings.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Program.
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\u003eDisable participation in a specified program for an account, requiring admin access.\u003c/p\u003e\n"],["\u003cp\u003eSend an empty POST request to the provided URL with the account and program specified as path parameters.\u003c/p\u003e\n"],["\u003cp\u003eUpon successful execution, the response will include the updated Program details.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/content\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document details how to disable a program for a specific account using an HTTP POST request. The request URL targets a program using the format `accounts/*/programs/*` within the `merchantapi.googleapis.com` domain. The request body must be empty, and the method requires admin access and the OAuth scope `https://www.googleapis.com/auth/content`. Successful execution returns a `Program` object in the response body. The operation uses gRPC Transcoding syntax, and path parameters are detailed in the provided table.\n"],null,["# Method: accounts.programs.disable\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nDisable participation in the specified program for the account.\n\n### HTTP request\n\n`POST https://merchantapi.googleapis.com/accounts/v1beta/{name=accounts/*/programs/*}:disable`\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 program for which to disable participation for the given account. Format: `accounts/{account}/programs/{program}`. For example, `accounts/123456/programs/free-listings`. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Program](/merchant/api/reference/rest/accounts_v1beta/accounts.programs#Program).\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)."]]
