Relationship Note Object v2

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

200
Returned if the request is successful.

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

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.

Relationship Note Attributes

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

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.

QV Systems Knowledge Base