POST /proposal/notes

NOTE: The EPA API has sunset on September 30, 2026. Endpoints are no longer accessible. For alternatives, see EPA to PDP Migration.

Submits a new note to an existing proposal and return.

Here's what you need to know:

Notes represent a communication between Seller and Buyer associated with the proposal.
After you create a note, its contents return in the response.
The POST /proposal/notes endpoint does not create a new revision.

Request example

To add a note to a proposal, use the POST /proposal/notes endpoint.

{
    "ProposalId": 123,
    "RevisionNumber": 3,
    "Content": "The body of the note"
}

Request object properties

The following table lists the POST /proposal/notes request object properties.

Property	Required?	Value Type	Description
`ProposalId`	Required	Integer	The unique ID of the proposal to which you want to add this note.
`RevisionNumber`	Required	Integer	The proposal revision number to which you want to add this note.
`Content`	Required	String	The body of the note to attach to the proposal. The maximum character amount is 4000. IMPORTANT: The contents in this field cannot be modified after the note is created.

Response example

A successful response to a POST /proposal/notes request returns a Note object that includes the date and time of creation and identifies if the buyer or seller created it.

{
    "NoteId": 651,
    "ProposalId": 123,
    "RevisionNumber": 3,
    "CreateTime": "2022-08-19T18:53:18.05",
    "CreatedBy": "Seller",
    "Content": " The body of the note"
}

Response object properties

The following table lists the POST /proposal/notes response object properties.

Property	Value Type	Description
`NoteId`	Integer	The unique ID of the note to that was generated on creation.
`ProposalId`	Integer	The unique ID of the proposal to which the note was added.
`RevisionNumber`	Integer	The proposal revision number to which the note was added.
`CreatedBy`	String	The party who created this note: `Buyer` or `Seller`.
`CreateTime`	String	The date and time when the note was added.
`Content`	String	The body of the note that was attached to the proposal. The maximum character count is 4000. IMPORTANT: The contents in this field cannot be modified after the note is created.

Error codes and messages

The following table provides a list of common errors and their respective HTTP error codes.

HTTP Code	Status	Description
400	Bad Request	The request had missing or invalid parameters.
403	Forbidden	The proposal is in the Rejected state and has not been activated.
404	Not Found	The proposal or revision does not exist.
409	Conflict	A newer revision already exists.
410	Gone	The proposal has been deleted by the buyer or seller.