Method: buyers.proposals.deals.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes.
HTTP request
PATCH https://authorizedbuyersmarketplace.googleapis.com/v1/{deal.name=buyers/*/proposals/*/deals/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
deal.name |
string
Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
|
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 Deal.
Response body
If successful, the response body contains an instance of Deal.
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 given deal at the buyer's known revision number, returning an error if the server revision has advanced since the provided revision.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/authorized-buyers-marketplace\u003c/code\u003e authorization scope for access.\u003c/p\u003e\n"],["\u003cp\u003eUses a \u003ccode\u003ePATCH\u003c/code\u003e request to \u003ccode\u003ehttps://authorizedbuyersmarketplace.googleapis.com/v1/{deal.name=buyers/*/proposals/*/deals/*}\u003c/code\u003e with path and query parameters to specify the deal and fields to update.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain a \u003ca href=\"/authorized-buyers/apis/marketplace/reference/rest/v1/buyers.proposals.deals#Deal\"\u003eDeal\u003c/a\u003e object representing the updated deal information.\u003c/p\u003e\n"],["\u003cp\u003eA successful response will return the updated \u003ca href=\"/authorized-buyers/apis/marketplace/reference/rest/v1/buyers.proposals.deals#Deal\"\u003eDeal\u003c/a\u003e object.\u003c/p\u003e\n"]]],[],null,["# Method: buyers.proposals.deals.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 given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes.\n\n### HTTP request\n\n`PATCH https://authorizedbuyersmarketplace.googleapis.com/v1/{deal.name=buyers/*/proposals/*/deals/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `deal.name` | `string` Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId} |\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 [Deal](/authorized-buyers/apis/marketplace/reference/rest/v1/buyers.proposals.deals#Deal).\n\n### Response body\n\nIf successful, the response body contains an instance of [Deal](/authorized-buyers/apis/marketplace/reference/rest/v1/buyers.proposals.deals#Deal).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/authorized-buyers-marketplace`"]]
