Skip to main content
PATCH
/
api
/
Customers
/
{customerId}
/
address
/
{addressId}
Error
A valid request URL is required to generate request examples
{
  "customerId": 1,
  "merchantCustomerRefId": "1234-5678-9101",
  "firstName": "John",
  "lastName": "Doe",
  "billingAddresses": [
    {
      "addressId": 1,
      "addressLine1": "101 Update Street",
      "addressLine2": "",
      "city": "Irvine",
      "state": "CA",
      "postalCode": "92602",
      "phoneNumber": null,
      "email": null,
      "country": "US"
    }
  ],
  "shippingAddresses": [],
  "taxAddresses": [],
  "subscriptions": []
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
customerId
integer<int64>
required
Required range: 1 <= x <= 1000000000
​
addressId
integer<int64>
required
Required range: 1 <= x <= 1000000000

Body

​
addressLine1
string | null

Address.

Maximum string length: 3000
​
addressLine2
string

Supplemental information for the address.

Maximum string length: 3000
​
city
string | null

City.

Maximum string length: 3000
​
state
string | null

State.

Maximum string length: 2
​
postalCode
string | null

Postal Code.

Required string length: 2 - 20
​
phoneNumber
string

The phone number associated with a payment method that is used for billing purposes.

Required string length: 7 - 21
Pattern: ^(?=.*\d)\+?[0-9\s\-\(\)\.]{7,20}$
​
email
string<email>

The email associated with a billing address.

Maximum string length: 3000
​
country
string

The input must be a valid Alpha2 code, Alpha3 code, UN code, or full country name.

Maximum string length: 2

Response

OK

​
customerId
integer<int64>
Required range: 1 <= x <= 1000000000
​
merchantCustomerRefId
string | null
Maximum string length: 100
​
firstName
string | null
Maximum string length: 150
​
lastName
string | null
Maximum string length: 150
​
billingAddresses
object[] | null
​
shippingAddresses
object[] | null
​
taxAddresses
object[] | null
​
subscriptions
object[] | null