Method: buyers.proposals.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is only allowed for buyer private data, all other fields are immutable.
HTTP request
PATCH https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{proposal.name=buyers/*/proposals/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
proposal.name |
string
Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
|
Query parameters
| Parameters |
updateMask |
string (FieldMask format)
List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask. This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
|
Request body
The request body contains an instance of Proposal.
Response body
If successful, the response body contains an instance of Proposal.
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 2025-06-12 UTC.
[null,null,["Last updated 2025-06-12 UTC."],[[["\u003cp\u003eUpdates a proposal with the given revision, returning an error if the provided revision is outdated.\u003c/p\u003e\n"],["\u003cp\u003eOnly specified fields in the \u003ccode\u003eupdateMask\u003c/code\u003e query parameter are modified; immutable and output-only fields are ignored.\u003c/p\u003e\n"],["\u003cp\u003ePrivate auction proposals cannot be updated and will result in an error.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/authorized-buyers-marketplace\u003c/code\u003e authorization scope.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain a \u003ccode\u003eProposal\u003c/code\u003e object with desired updates.\u003c/p\u003e\n"]]],[],null,["# Method: buyers.proposals.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See [FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask) for how to use FieldMask. Only fields specified in the [UpdateProposalRequest.update_mask](/authorized-buyers/apis/marketplace/reference/rest/v1alpha/buyers.proposals/patch#body.QUERY_PARAMETERS.update_mask) will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the [UpdateProposalRequest.update_mask](/authorized-buyers/apis/marketplace/reference/rest/v1alpha/buyers.proposals/patch#body.QUERY_PARAMETERS.update_mask) will be ignored and left unchanged. Updating a private auction proposal is only allowed for buyer private data, all other fields are immutable.\n\n### HTTP request\n\n`PATCH https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{proposal.name=buyers/*/proposals/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------------------|\n| `proposal.name` | `string` Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId} |\n\n### Query parameters\n\n| Parameters ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"\\*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask. This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n\n### Request body\n\nThe request body contains an instance of [Proposal](/authorized-buyers/apis/marketplace/reference/rest/v1alpha/buyers.proposals#Proposal).\n\n### Response body\n\nIf successful, the response body contains an instance of [Proposal](/authorized-buyers/apis/marketplace/reference/rest/v1alpha/buyers.proposals#Proposal).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/authorized-buyers-marketplace`"]]
