Skip to main content
PATCH
/
v2
/
customers
/
{customer_id}
/
addresses
/
{address_id}
Update Address
curl --request PATCH \
  --url https://api.wizcommerce.com/v2/customers/{customer_id}/addresses/{address_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "reference_id": "ADDR123",
  "first_name": "John",
  "last_name": "Doe",
  "phone": "+14155552671",
  "email": "john.doe@example.com",
  "address_line_1": "123 Main St",
  "address_line_2": "Apt 101",
  "city": "Anytown",
  "state": "CA",
  "country": "US",
  "zip_code": "12345",
  "type": "billing",
  "is_default": true,
  "attributes": [
    {
      "name": "1234567890",
      "value": "red"
    }
  ]
}
'
{
  "data": {
    "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
    "customer_id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
    "reference_id": "ADDR123",
    "first_name": "John",
    "last_name": "Doe",
    "phone": "+14155552671",
    "email": "john.doe@example.com",
    "address_line_1": "123 Main St",
    "address_line_2": "Apt 101",
    "city": "Anytown",
    "state": "CA",
    "country": "USA",
    "zip_code": "12345",
    "type": "billing",
    "is_default": false,
    "attributes": [
      {
        "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "name": "Color",
        "value": "Red",
        "created_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "updated_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "created_at": "2021-01-01T00:00:00Z",
        "updated_at": "2021-01-01T00:00:00Z"
      }
    ],
    "created_at": "2025-01-01T15:04:05Z",
    "updated_at": "2025-01-01T15:04:05Z"
  }
}
The PATCH request is used to partially update an existing entity by the given id. This means:
  • Only the fields provided in the request body will be updated.
  • Fields not provided in the request body will remain unchanged.
  • The request is idempotent, meaning multiple identical PATCH requests will always result in the same final state.

Authorizations

​
X-API-Key
string
header
required

API Key for authentication

Path Parameters

​
customer_id
string
required

customer_id

​
address_id
string
required

address_id

Body

application/json

request

​
reference_id
string
Maximum string length: 255
Example:

"ADDR123"

​
first_name
string
Maximum string length: 50
Example:

"John"

​
last_name
string
Maximum string length: 50
Example:

"Doe"

​
phone
string
Example:

"+14155552671"

​
email
string
Example:

"john.doe@example.com"

​
address_line_1
string
Maximum string length: 255
Example:

"123 Main St"

​
address_line_2
string
Maximum string length: 255
Example:

"Apt 101"

​
city
string
Maximum string length: 50
Example:

"Anytown"

​
state
string
Maximum string length: 50
Example:

"CA"

​
country
string
Example:

"US"

​
zip_code
string
Maximum string length: 50
Example:

"12345"

​
type
enum<string>
Available options:
billing,
shipping
Example:

"billing"

​
is_default
boolean
​
attributes
object[]

Response

OK

​
data
object