Set address

Endpoint

POST - /Clients/SetAddress

Overview

Used to update an existing Business address for a client.

Parameters

clientLink

stringFieldsMustMatch

Boolean (True/False)

• When true: If Country/State are used instead of CountryLink/StateLink, they will fail if not matched to a known value.
• When false: If they do not match a known value they will be entered as free text.

address

String. The street address

street

String. The street address

city

String. The city

state

String. The city in text/string form. Can also use the integer value “statelink” to set to a known value - see below.

statelink

Integer. The statelink that corresponds to a value in the database table “tblCountryStates.PKID”

postCode

String. The postcode

country

String. The country in text/string form. Can also use the integer value “countrylink” to set to a known value - see below.

countrylink

Integer. The countrylink that corresponds to a value in the database table “tblCountries.PKID”

location

String. Additional information about the location.

Example

Remember that this endpoint can only be used to update an existing business address.

{
  "clientLink": 316,
  "stringFieldsMustMatch": true,
  "address": {
    "street": "123 Northbourne Avenue",
    "city": "Braddon",
    "state": "Australian Capital Territory",
    "stateLink": 0,
    "postCode": "2602",
    "country": "Australia",
    "countryLink": 0,
    "location": "2nd floor"
  }
}

See also

Clients