Customers

Update address

Change one address of a customer.

PATCH/v1/customers/{customerId}/addresses/{addressId}

Bearer tokenReturns JSONSuccess 200

Send only the fields you want to change. Orders already created keep the address as it was when they were made.

Request

Headers

Field	Type	Description
`Authorization`required	`string`	The access token from Get token, as "Bearer <token>".
`Content-Type`required	`string`	Always application/json when a body is sent.

Path parameters

Field	Type	Description
`customerId`required	`string`	The customer's id.
`addressId`required	`string`	The address's id, from List addresses.

Request body

Field	Type	Description
`formattedAddress`optional	`string`	The full address as one line.
`countryId`optional	`string`	Country id, from List countries.
`stateId`optional	`string`	State id, from List states.
`cityId`optional	`string`	City id, from List cities. Needed for the coverage check.
`buildingUnit`optional	`string`	Building, floor or unit.
`postalCode`optional	`string`	Postal code.
`latitude`optional	`number`	Latitude, if you have it.
`longitude`optional	`number`	Longitude, if you have it.
`customFieldValues`optional	`object`	Extra fields some countries require, as key and value pairs.
`label`optional	`string`	A short name for the address, for example Home.
`contactName`optional	`string`	Who to ask for at this address.
`contactPhone`optional	`string`	Phone number at this address.
`deliveryInstructions`optional	`string`	Instructions for the driver.

Example request

curl -X PATCH "https://api.swiftazu.com/v1/customers/8778df1e-9b74-420d-b826-d17cdad86d36/addresses/0df7f36c-417a-4145-b956-743f66c4f9b7" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "deliveryInstructions": "Call on arrival"
}'

Response

Example response · 200

{
  "status": "ok"
}

Errors

HTTP	Code	Meaning
404	`not_found`	The record does not exist, or it is not yours.
400	`invalid_request`	The request broke a business rule. message says which one.

Every call can also return the shared errors listed on the Overview page. Overview