Profile Addresses

📘

Default profile addresses

Multiple addresses can be stored against a profile, but only one can be the default.
Setting an address's is_default to true, will change the other addresses is_default to false.

"data": [
    {
        "id": 8,
        "address_line_1": "234 First Street",
        "address_line_2": "Buckaby Lane",
        "address_line_3": "County Crt",
        "company": "Acme Pants Co",
        "latitude": null,
        "longitude": null,
        "city": "Melbourne",
        "postcode": "3002",
        "state": "Victoria",
        "country": "Australia",
        "notes": null,
        "external_id": "12341234",
        "is_default": true,
        "created_at": "2021-01-25 02:10:47",
        "updated_at": "2021-02-01 04:16:45"
    },
    {
        "id": 9,
        "address_line_1": "123 Backup Lane",
        "address_line_2": null,
        "address_line_3": null,
        "company": "Miasma Inc",
        "latitude": null,
        "longitude": null,
        "city": "Melbourne",
        "postcode": "3002",
        "state": "Victoria",
        "country": "Australia",
        "notes": null,
        "external_id": null,
        "is_default": false,
        "created_at": "2021-01-25 02:23:01",
        "updated_at": "2021-02-01 04:15:30"
    }
]

Profile Address Properties

Attribute

Description

id INTEGER READ_ONLY

The id of the address

address_line_1
STRING

Line one of the profile address

address_line_2
STRING

Line two of the profile address

address_line_3
STRING

Line three of the profile address

company
STRING

The company residing at the address

latitude
READ_ONLY

the latitude of the address

longitude
READ_ONLY

the longitude of the address

city
STRING

The city of the address

postcode
STRING

The postcode of the address

state
STRING

The state of the address

country
STRING

The country of the address

notes
STRING

Notes against this address

external_id
STRING

An external id for the associated address
can be null if this does not apply

is_default
BOOLEAN

Denotes whether this address is the default profile address

created_at
DATE-TIME
READ-ONLY

The UTC date & time the Address record was created in ISO 8601 format.

updated_at
DATE-TIME
READ-ONLY

The UTC date & time the Address record was last updated in ISO 8601 format.

`