Skip to main content

Contact Address Object v2

A technical guide to retrieving, adding, and updating contact addresses in Accelerate using API v2.

Funmilola Olorode avatar
Written by Funmilola Olorode
Updated over 6 months ago

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

opportunity ID REQUIRED
integer - ID of your chosen opportunity

address ID OPTIONAL
integer - ID of your chosen address

Contact Address Requests

GET POST PUT

GET POST - Retrieve an address from a contact or add a new address to a contact

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/relationships/{id}/contacts/{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": 1176565,
            "address_type": "Primary",
            "property": "Unit A",
            "street": "Platform",
            "locality": "45 St. Peters Street",
            "town_city": "BEDFORD",
            "postcode": "MK40 2FL",
            "country": null,
            "valid_from": null,
            "valid_to": null,
            "residential_status": null
        }
    ]
}

PUT - Update an existing address on a contact

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

Example Payload

PUT

{
  "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.

A successful PUT request will not return a response object.

{}

Contact Address Attributes

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

Mandatory Fields

Expand to see the list of mandatory fields

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 .

property - string

street - string

locality - string

country - string

valid_from - date

valid_to - date

residential_status - string
Must be one of Outright owner, Mortgaged owner, Renting, Living with parents, Co-Owner or Housing Authority Tenant


​

Related Articles
Address Object v2
Driver Object v2
Marketing Permissions Object v2
Contact Object v2
Asset Object v2
Did this answer your question?