Skip to main content
PATCH
/
addresses
/
{id}
Updates a Address
curl --request PATCH \
  --url https://commerce.driv.ly/api/addresses/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "name": "<string>",
  "street": "<string>",
  "suite": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "country": "<string>",
  "deals": [
    123
  ],
  "tenants": 123,
  "customer": [
    123
  ],
  "contact": [
    123
  ]
}
'
{
  "doc": {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "name": "<string>",
    "street": "<string>",
    "suite": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>",
    "deals": [
      123
    ],
    "tenants": 123,
    "customer": [
      123
    ],
    "contact": [
      123
    ]
  },
  "message": "<string>"
}
Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { addresses } from '@drivly/commerce'

const sdk = new SDK(...)

const addresses = await sdk.addresses.update(addressesId: string, data: addresses): Promise<addresses>

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

id of the Address

Query Parameters

​
depth
number

number of levels to automatically populate relationships and uploads

​
locale
string

retrieves document(s) in a specific locale

​
fallback-locale
string

specifies a fallback locale if no locale value exists

Body

application/json
​
updatedAt
string
required
​
createdAt
string
required
​
name
string | null
​
street
string | null
​
suite
string | null
​
city
string | null
​
state
string | null
​
zip
string | null
​
country
string | null
​
deals
(number | Deal · object)[] | null
​
tenants
​
customer
(number | Customer · object)[] | null
​
contact
(number | Contact · object)[] | null

Response

ok

​
doc
Address · object
required
​
message
string
required