Update an address

Updates values in an existing address

SecurityShippo_Token
Request
path Parameters
address_id
required
string (Address Id)
Request Body schema: application/json
required
name
required
string (Name) <= 64 characters

The name of the addressee

Organization (string) or Organization (null) (Organization)

The organization of the addressee

Email (string) or Email (null) (Email)

The email of the addressee

Phone (string) or Phone (null) (Phone)

The phone number of the addressee

address_line_1
required
string (Address Line 1) [ 1 .. 100 ] characters

The first line of the address

Address Line 2 (string) or Address Line 2 (null) (Address Line 2)

The second line of the address

City Locality (string) or City Locality (null) (City Locality)

The city or locality of the address

State Province (string) or State Province (null) (State Province)

The state, province, county, or municipal division

Postal Code (string) or Postal Code (string) (Postal Code)

The postal code or zip code

country_code
required
string (Country Code) = 2 characters

The ISO 3166 country code

address_type
string (AddressType)
Default: "unknown"

The category of the address. It may affect how certain carriers charge for a delivery/pickup.It is recommended to specify it, if it is known.

Enum: "unknown" "residential" "commercial" "po_box" "military"
Responses
204

Successful Response

404

Not Found

409

Conflict

422

Unprocessable Entity

5XX

Server Error

put/v2/addresses/{address_id}
Request samples
application/json
{
  • "name": "Wilson",
  • "organization": "Shippo",
  • "email": "user@shippo.com",
  • "phone": "+1-4155550132",
  • "address_line_1": "731 Market Street",
  • "address_line_2": "#200",
  • "city_locality": "San Francisco",
  • "state_province": "CA",
  • "postal_code": "94103",
  • "country_code": "US",
  • "address_type": "residential"
}
Response samples
application/json
{
  • "detail": "Not Found"
}