Path Parameters

HTTP Header

api-key REQUIRED

string - Your Accelerate API Key

URL Substitution

subdomain REQUIRED
string - Your Accelerate subdomain

relationship ID REQUIRED
integer - ID of your chosen relationship

Relationship Note Requests

GET POST

GET POST - Retrieve notes for a relationship or add a new note into a relationship.

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

Example Payload

POST

{
    "text": "Do we need to contact James to make sure he wishes to proceed?"
}

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.

{
    "items": [
        {
            "text": "James' could be a really good opportunity for a high-end vehicle. ",
            "creation_date": "2022-08-03 10:04:16",
            "created_by": "[email protected]"
        }
    ],
    "first": {
        "$ref": "https://demo.quotevineapp.com/qvine/quotevine/api/v2/relationships/2300191/notes/"
    }
}

Relationship Note Attributes

When adding a new note to a relationship via the API, there is one field that is needed.

Mandatory Fields

Expand to see the list of mandatory fields

text - string
Maximum of 4000 characters. If you want to send a newline, you can use <br>,<br/> or <br />

Non Mandatory Fields

There are no Non-Mandatory fields for this type of request.

Address Object v2

Cookie Object v2

Driver Object v2

Marketing Permissions Object v2

Proposal Notes v2

Relationship Note Object v2