Skip to main content
PATCH
/
addresses
/
{id}
Update an existing Address
curl --request PATCH \
  --url https://commerce.driv.ly/api/addresses/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "city": {
    "state": "<string>",
    "name": "<string>"
  },
  "zip": "<string>",
  "line2": "<string>",
  "line1": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "city": {
      "state": "<string>",
      "name": "<string>"
    },
    "zip": "<string>",
    "line1": "<string>",
    "line2": "<string>"
  },
  "success": true
}

Path Parameters

id
string
required

Address is uniquely identified by id

Query Parameters

depth
integer

The number of levels of related objects to include in the response

Body

application/json
id
string

Address is uniquely identified by id

city
object

Address is located in City

zip
string

Address has ZIP

line2
string

Address has Address Line 2

line1
string

Address has Address Line 1

Response

Address Updated

data
Address · object
Example:
{
"id": "adr_2kj49d1msod2",
"zip": "62704",
"city": {
"name": "Springfield",
"state": { "code": "IL" }
},
"line2": "Apt 201",
"line1": "456 Elm Street"
}
success
boolean