Clients / Addresses / Create

Name	Clients / Addresses / Create
Description	Create one or more addresses for an existing client
Type	POST
URL	/v9/clients/:client_id/addresses
Credential Type	API

Long Description

Create one or more addresses for an existing client. Note that this takes an array of addresses even if only creating one.

Parameters

Name	Description	Type	Presence	Location	Limitations
`client_id`	The ID of the specific Client	Integer	Required	URI
`label`	Arbitrary description, like 'home' or 'office'	String	Optional	Body	20 characters max
`name`	Name of the person at this address	String	Optional	Body
`company`	Company name in the address	String	Optional	Body	50 characters max
`street_address`	Street address of the new address	String	Optional	Body
`extended_address`	Second line of the street address	String	Optional	Body
`locality`	City	String	Optional	Body
`region`	State or province	String	Optional	Body
`postal_code`	Zip code	String	Optional	Body
`country_code`	2 digit ISO 3166-1 alpha-2 Country Code	String	Optional	Body
`primary`	Indicate that this is the primary address for this client.	Boolean	Optional	Body
`is_primary_shipping`	Indicate that this is the primary shipping address for this client.	Boolean	Optional	Body
`is_primary_billing`	Indicate that this is the primary billing address for this client.	Boolean	Optional	Body

Examples

Request Response

POST /clients/168019/addresses

Create a single address.

{
  "addresses": [
    {
      "label": "home",
      "name": "Ned Flanders",
      "company": null,
      "street_address": "742 Evergreen Terrace",
      "extended_address": null,
      "locality": "Springfield",
      "region": "OR",
      "postal_code": "97475",
      "country_code": "US",
      "is_primary_shipping": true,
      "is_primary_billing": true
    }
  ]
}

{
  "current_page": 1,
  "per_page": 100,
  "total_entries": 1,
  "addresses": [
    {
      "country_code": "US",
      "longitude": null,
      "street_address": "742 Evergreen Terrace",
      "locality": "Springfield",
      "label": "home",
      "id": 645263,
      "latitude": null,
      "postal_code": "97475",
      "region": "OR",
      "extended_address": null,
      "po_box": false,
      "name": "Ned Flanders",
      "primary": true,
      "updated_at": "2017-12-15T00:03:46Z",
      "url": "/clients/168019/addresses/645263"
    }
  ]
}

Create multiple addresses for the same client in a single request.

{
  "addresses": [
    {
      "label": "home",
      "name": "Ned Flanders",
      "company": null,
      "street_address": "742 Evergreen Terrace",
      "extended_address": null,
      "locality": "Springfield",
      "region": "OR",
      "postal_code": "97475",
      "country_code": "US",
      "is_primary_shipping": false,
      "is_primary_billing": true
    },
    {
      "label": "work",
      "name": "Ned Flanders",
      "company": "The Leftorium",
      "street_address": "7721 Springfield Mall Drive",
      "extended_address": "Suite 202",
      "locality": "Springfield",
      "region": "OR",
      "postal_code": "97475",
      "country_code": "US",
      "is_primary_shipping": true,
      "is_primary_billing": false
    }
  ]
}

{
  "current_page": 1,
  "per_page": 100,
  "total_entries": 2,
  "addresses": [
    {
      "country_code": "US",
      "longitude": null,
      "street_address": "742 Evergreen Terrace",
      "locality": "Springfield",
      "label": "home",
      "id": 645264,
      "latitude": null,
      "postal_code": "97475",
      "region": "OR",
      "extended_address": null,
      "po_box": false,
      "name": "Ned Flanders",
      "primary": false,
      "updated_at": "2017-12-15T00:04:58Z",
      "url": "/clients/168019/addresses/645264"
    },
    {
      "country_code": "US",
      "longitude": null,
      "street_address": "7721 Springfield Mall Drive",
      "locality": "Springfield",
      "label": "work",
      "id": 645265,
      "latitude": null,
      "postal_code": "97475",
      "region": "OR",
      "extended_address": "Suite 202",
      "po_box": false,
      "name": "Ned Flanders",
      "primary": true,
      "updated_at": "2017-12-15T00:04:58Z",
      "url": "/clients/168019/addresses/645265"
    }
  ]
}