Method: buyers.proposals.addNote
Stay organized with collections
Save and categorize content based on your preferences.
Creates a note for this proposal and sends to the seller. This method is not supported for proposals with DealType
set to 'PRIVATE_AUCTION'.
HTTP request
POST https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{proposal=buyers/*/proposals/*}:addNote
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
proposal |
string
Name of the proposal. Format: buyers/{accountId}/proposals/{proposalId}
|
Request body
The request body contains data with the following structure:
JSON representation |
{
"note": {
object (Note )
}
} |
Fields |
note |
object (Note )
The note to add.
|
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 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eThis documentation outlines the process for adding a note to a proposal using the Authorized Buyers Marketplace API.\u003c/p\u003e\n"],["\u003cp\u003eThe request is sent as a POST request to a specific endpoint with the proposal name as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eA JSON structured request body includes the note content, and a successful response returns the updated proposal.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is needed via an OAuth scope related to the Authorized Buyers Marketplace.\u003c/p\u003e\n"],["\u003cp\u003eThe method is incompatible with proposals classified as 'PRIVATE_AUCTION' according to the 'DealType'.\u003c/p\u003e\n"]]],["This describes the process of adding a note to a proposal via an HTTP POST request to `https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{proposal=buyers/*/proposals/*}:addNote`. The request requires a `proposal` path parameter and a JSON request body containing a `note` object. The operation is unsupported for proposals with 'PRIVATE_AUCTION' deal types. Upon success, a `Proposal` instance is returned, authenticated by the `authorized-buyers-marketplace` OAuth scope.\n"],null,["# Method: buyers.proposals.addNote\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\nCreates a note for this proposal and sends to the seller. This method is not supported for proposals with [DealType](/authorized-buyers/apis/marketplace/reference/rest/v1alpha/DealType) set to 'PRIVATE_AUCTION'.\n\n### HTTP request\n\n`POST https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{proposal=buyers/*/proposals/*}:addNote`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------|\n| `proposal` | `string` Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------|\n| ``` { \"note\": { object (/authorized-buyers/apis/marketplace/reference/rest/v1alpha/buyers.proposals#Note) } } ``` |\n\n| Fields ||\n|--------|------------------------------------------------------------------------------------------------------------------------|\n| `note` | `object (`[Note](/authorized-buyers/apis/marketplace/reference/rest/v1alpha/buyers.proposals#Note)`)` The note to add. |\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`"]]