API Update an address

PUT   https://:account.api-us1.com/api/3/addresses/:id

• JSON

{
	"address": {
        "companyName": "New Test Company Name",
        "address1": "111 New Test Address",
        "address2": "",
        "city": "New Test City",
        "state": "Florida",
        "zip": "12345",
    		"country": "US"
	}  
}

 

 

 200 OK

{
    "address": {
        "companyName": "New Test Company Name",
        "address1": "111 New Test Address",
        "address2": "",
        "city": "New Test City",
        "state": "Florida",
        "district": "",
        "zip": "12345",
        "country": "US",
        "allgroup": "0",
        "isDefault": "1",
        "links": {
            "addressGroup": "https://:account.api-us1.com/api/3/addresses/1/addressGroup",
            "addressList": "https://:account.api-us1.com/api/3/addresses/1/addressList",
            "forms": "https://:account.api-us1.com/api/3/addresses/1/forms"
        },
        "id": "1"
    }
}

404 Not Found

{
    "message": "No Result found for Address with id 3"
}

PATH PARAMS

 

ID                                                              REQUIRED

string                                                        ID of the Address being changed

 

BODY PARAMS

 

address

object

 

address.groupid

int32

 

address.global

mixed type

 

address.company_name      REQUIRED

string

 

address.address_1               REQUIRED

string

 

address.address_2

string

 

address.city

string

 

address.state

string

 

address.zip

string

 

address.district

string                                  (Optional for countries that use it)

 

address.country                 REQUIRED

string                                  Accepts a (2) two character string - country code (eg 'US', 'CA', 'MX')

 

address.allgroup

int32

 

address.is_default

boolean                               Indicates default address