Update Address

Beta

PATCH/v1/sales/addresses/{id}

Idempotent with Idempotency-Key header. Learn more

Partially updates an address.

Changing a street, locality, state, postal code, or country field may replace the address's geolocation, so the geolocation id in the response can change.

Permissions requiredValues:addresses:updatecustomers:updatesuppliers:update

The role behind your API key or agent must grant every one of these permissions.

idstring

Address ID.

nameoptional string

Display name of the address.

phoneoptional stringnullable

Phone number associated with the address.

Send null to clear. Send null to clear.

emailoptional stringnullable

Email address associated with the address.

Send null to clear. Send null to clear.

typeoptional stringenumValues:standarddrop_ship

How the address is used.

standard: a normal shipping or billing address.
drop_ship: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.

street_line_1optional string

First line of the street address.

street_line_2optional stringnullable

Second line of the street address.

Send null to clear. Send null to clear.

localityoptional string

City or locality.

stateoptional string

State or administrative area.

postal_codeoptional string

Postal or ZIP code.

countryoptional string

Two-letter country code.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

typestringenumValues:standarddrop_ship

How the address is used.

standard: a normal shipping or billing address.
drop_ship: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.

geolocationgeolocationnullable

Geolocation details for the address.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Update Address

Update Address

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const address = await client.sales.addresses.update('ad_012100950cfaa34aa0e0ad7258', {
  name: 'Warehouse',
});

console.log(address.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const address = await client.sales.addresses.update('ad_012100950cfaa34aa0e0ad7258', {
  name: 'Warehouse',
});

console.log(address.id);

200 example

{
  "id": "ad_012100950cfaa34aa0e0ad7258",
  "object": "address",
  "name": "Headquarters",
  "phone": null,
  "email": null,
  "type": "standard",
  "geolocation": {
    "id": "gl_013e4c26412103c6757ba71806",
    "object": "geolocation",
    "street_line_1": "4200 Industrial Pkwy",
    "street_line_2": null,
    "locality": "Columbus",
    "state": "OH",
    "postal_code": "43204",
    "country": "US"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "ad_012100950cfaa34aa0e0ad7258",
  "object": "address",
  "name": "Headquarters",
  "phone": null,
  "email": null,
  "type": "standard",
  "geolocation": {
    "id": "gl_013e4c26412103c6757ba71806",
    "object": "geolocation",
    "street_line_1": "4200 Industrial Pkwy",
    "street_line_2": null,
    "locality": "Columbus",
    "state": "OH",
    "postal_code": "43204",
    "country": "US"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Update Address

Authorization

Path Parameters

Request Body

Returns

Responses