⬆️Update Address

A Customers residential Address details may be updated if required.

Update Address

PATCH {{baseUrl}}/addresses/:address_id

The Customers Address record can be changed/updated whilst maintaining the same address_id.

Path Parameters

Name	Type	Description
address_id*	String	The UUID for a specific address that gets generated and returned in the POST Create New Address response.

Request Body

Name	Type	Description
address_line_1	String	This is the first line of the Customer's address. This is what the customer would enter for the first line of their address if they were filling out a form. It would usually be their street number and name (e.g. 12 Plain Street). If their address is in a complex or estate for example, it may be the unit number (e.g. Unit 53).
address_line_2	String	This is the second line of the Customer's address. This is what the customer would enter for the second line of their address if they were filling out a form. It is more common to have a second line in the address if it is in a complex or estate (e.g. Roeland Square).
suburb	String	This is the suburb where the address is located.
city	String	This is the city where the address is located.
province	String	This is the province where the address is located.
postal_code	String	This is the 4-digit postal code.

200: OK Update Address Line 1

```json
{
    "data": {
        "id": "{{addressId}}",
        "address_line_1": "10 Highlands Avenue",
        "address_line_2": "Parkdene",
        "suburb": "Boksburg",
        "city": "Johannesburg",
        "province": "Gauteng",
        "postal_code": "1459"
    }
}
```

404: Not Found AddressId Not Found

```json
{
    "errors": {
        "code": "entity_not_found",
        "message": "Record not found in addresses"
    }
}
```

Before: Available Address Record

```json
{
    "data": {
        "id": "{{addressId}}",
        "address_line_1": "27 Lanner Street",
        "address_line_2": "Parkdene",
        "suburb": "Boksburg",
        "city": "Johannesburg",
        "province": "Gauteng",
        "postal_code": "1459"
    }
}
```

Patch: Update the Customers address line 1 and postal code

```json
{
    "address_line_1": "10 Highlands Avenue"
    "postal_code":"2001"
}
```

After: Updated Address Record

```json
{
    "data": {
        "id": "{{addressId}}",
        "address_line_1": "10 Highlands Avenue",
        "address_line_2": "Parkdene",
        "suburb": "Boksburg",
        "city": "Johannesburg",
        "province": "Gauteng",
        "postal_code": "2001"
    }
}
```