Method: buyers.clients.deactivate
Stay organized with collections
Save and categorize content based on your preferences.
Deactivates an existing client. The state of the client will be updated to "INACTIVE". This method has no effect if the client is already in "INACTIVE" state.
HTTP request
POST https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{name=buyers/*/clients/*}:deactivate
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. Format: buyers/{buyerAccountId}/clients/{clientAccountId}
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Client.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/authorized-buyers-marketplace
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 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eDeactivates an existing client, setting its state to "INACTIVE" if it's not already.\u003c/p\u003e\n"],["\u003cp\u003eRequires an HTTP POST request to a specific URL with buyer and client IDs as path parameters.\u003c/p\u003e\n"],["\u003cp\u003eAn empty request body is required, and a successful response returns the updated client details.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is needed using the "https://www.googleapis.com/auth/authorized-buyers-marketplace" scope.\u003c/p\u003e\n"]]],["The core function is to deactivate a client via a `POST` HTTP request to a specific URL. The URL structure, defined by gRPC Transcoding, requires a client's unique identifier in the `name` path parameter, formatted as `buyers/{buyerAccountId}/clients/{clientAccountId}`. The request body must be empty. Upon successful execution, the client's state changes to \"INACTIVE,\" reflected in the returned `Client` response body. Authorization requires the `https://www.googleapis.com/auth/authorized-buyers-marketplace` OAuth scope.\n"],null,["# Method: buyers.clients.deactivate\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\nDeactivates an existing client. The state of the client will be updated to \"INACTIVE\". This method has no effect if the client is already in \"INACTIVE\" state.\n\n### HTTP request\n\n`POST https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{name=buyers/*/clients/*}:deactivate`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------------------------|\n| `name` | `string` Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` |\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 [Client](/authorized-buyers/apis/marketplace/reference/rest/v1alpha/buyers.clients#Client).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/authorized-buyers-marketplace`"]]
