Brand
Customer
Update Customer Address

Update Customer Address

This API allows updating an existing address for a customer. It ensures that customer contact and location details are current, accurate, and complete for deliveries, billing, or correspondence.

Overview

  • Method: PUT
  • Path: /brand/customer/update-customer-address
  • Tags: brand

Use Cases

  • Update address details when a customer moves or wants to correct an existing address.
  • Maintain accurate shipping and billing information for orders and communications.

Parameters

No parameters required.

Request Body

  • Content Type: application/json
  • Required: Yes

Fields

FieldTypeRequiredDetails
addressstringYes
last_namestringYes
address_1stringYes
address_2stringNomaxLength: 200
citystringYes
country_codestringYes
provincestringNomaxLength: 100
postal_codestringYes
phonestringYes
metadatarecord<string, object>Yes

Responses

200

Successful response

Content Type: application/json

{
  "address": "string",
  "first_name": "string",
  "last_name": "string",
  "address_1": "string",
  "address_2": "string",
  "city": "string",
  "country_code": "string",
  "province": "string",
  "postal_code": "string",
  "phone": "string",
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-01-01T00:00:00.000Z",
  "metadata": {
    "key": {}
  }
}

400

Bad Request

Content Type: application/json

{
  "error": "string",
  "details": [
    {}
  ]
}

401

Unauthorized

404

Not Found

500

Internal Server Error

Example Usage

curl -X PUT \
  https://api.pillexa.com/brand/customer/update-customer-address \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}'