Skip to main content

Proposal Notes v2

A technical guide to retrieving and adding notes to proposals within Accelerate using API v2.

Tom White avatar
Written by Tom White
Updated over 11 months ago

Path Parameters

HTTP Header

api-key REQUIRED

string - Your Accelerate API Key

URL Substitution

subdomain REQUIRED
string - Your Accelerate subdomain

proposal ID REQUIRED
integer - ID of your chosen proposal

Proposal Notes Requests

GET POST

Get Post - Retrieve all notes from a proposal or add a new note to a proposal

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/proposals/{id}/notes/

Example Payload

POST

{
    "text": "This is a note I am adding to a proposal"
}

Response

400
​

Returned if the request sent is invalid.

404
​

Returned if the request is not found or the user does not have permission to view it.

200
Returned if the request is successful.

Expand to see example of a successful response.

{
    "text": "This is a note I am adding to a proposal",
    "creation_date": "2022-08-18 13:07:18",
    "created_by": "Example person"
}

Proposal Notes Attributes

When adding a new proposal note via the API, there are a number of fields needed.

Mandatory Fields

Expand to see the list of mandatory fields

text - string

Non Mandatory Fields

Expand to see the list of non-mandatory fields

created_by - string
Must not be supplied when using Post

creation_date - date
Must not be supplied when using Post

Related Articles
Address Object v2
Contact Address Object v2
Relationship Note Object v2
Ancilliary Products v2
Search Proposals v2
Did this answer your question?