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

address ID OPTIONAL
integer - ID of your chosen address

Address Requests

GET POST PUT

GET POST - Retrieve all addresses from a relationship or add a new one.

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

Example Payload

POST

{
  "address_type": "Primary",
  "property": "Unit A",
  "street": "Platform",
  "locality": "45 St. Peters Street",
  "town_city": "BEDFORD",
  "postcode": "MK40 2FL",
  "country": "United Kingdom"
}

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": [
        {
            "address_id": 1176557,
            "address_type": "Primary",
            "property": "Unit A",
            "street": "Platform",
            "locality": "45 St. Peters Street",
            "town_city": "BEDFORD",
            "postcode": "MK40 2FL",
            "country": "United Kingdom",
            "valid_from": null,
            "valid_to": null,
            "residential_status": null
        }
    ],
    "first": {
        "$ref": "https://demo.quotevineapp.com/qvine/quotevine/api/v2/relationships/2300191/addresses/"
    }
}

PUT - Update an existing address linked to a relationship.

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

Example Payload

PUT

{
  "address_type": "Business",
  "property": "Unit A",
  "town_city": "BEDFORD",
  "postcode": "MK40 2FL"
}

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.

A successful PUT request will not return a response object.

{}

Address Attributes

When updating/adding a new Address via the API, there are a number of fields needed.

Mandatory Fields

Expand to see the list of mandatory fields

address type - string
Must be one of Home, Business, Primary, Billing, Registered, Other. Use Primary for the first address.

property - string

town_city - string

postcode - string

Non-Mandatory Fields

Expand to see the list of non-mandatory fields.

address_id - number
Must NOT be supplied when using POST or PUT .

street - string

locality - string

valid_from - date

valid_to - date

residential_status - string

Must be one of Outright owner, Mortgaged owner, Renting, Living with parents

Driver Object v2

Marketing Permissions Object v2

Contact Address Object v2

Relationship Note Object v2

Asset Object v2