# Create an address

**POST /api/v2/addresses**




## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters
### Headers
- **X-PLANNR-ACCOUNT-UUID** (string)




### Body: application/json (object)

- **account_uuids** (array)
  The UUIDs of the accounts who should own the address. These must only be client accounts.
- **primary_account_uuids** (array)
  The UUIDs of the accounts who should have the address as their primary address.
- **name** (string)
  The friendly name for the address.
- **is_primary** (boolean)
  When provided and set to true, it will make the created address the primary address for all of the account UUIDs provided.
- **address_1** (string)
  The first line of the address.
- **address_2** (string)
  The second line of the address.
- **address_3** (string)
  The third line of the address.
- **address_4** (string)
  The fourth line of the address.
- **town_city** (string)
  The town or city.
- **county** (string)
  The county.
- **postcode** (string)
  The postcode.
- **country** (string)
  The country.
- **moved_in_month** (integer)
  The month the client moved into this address.
- **moved_in_year** (integer)
  The year the client moved into this address.
- **moved_out_month** (integer)
  The month the client moved out of this address.
- **moved_out_year** (integer)
  The year the client moved out of this address.
- **residential_status** (string)
  The client's residential status when living at the address.
- **residential_status_other** (string)
  The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other.


## Responses
### 201


#### Body: application/json (object)
- **uuid** (string)
  The UUID of the resource.
- **created_at** (string)
  The timestamp of when the resource was created.
- **updated_at** (string)
  The timestamp of when the resource was updated.
- **name** (string)
  The friendly name for the address.
- **address_1** (string)
  The first line of the address.
- **address_2** (string)
  The second line of the address.
- **address_3** (string)
  The third line of the address.
- **address_4** (string)
  The fourth line of the address.
- **town_city** (string)
  The town or city.
- **county** (string)
  The county.
- **postcode** (string)
  The postcode.
- **country** (string)
  The country.
- **accounts** (object)
  The accounts who own the address. This may not be included when viewing all addresses. Refer to the documentation to include this field.
- **primary_accounts** (object)
  The accounts who own the address and have it as their primary address. This may not be included when viewing all addresses. Refer to the documentation to include this field.
- **moved_in_month** (integer)
  The month the client moved into this address.
- **moved_in_year** (integer)
  The year the client moved into this address.
- **moved_out_month** (integer)
  The month the client moved out of this address.
- **moved_out_year** (integer)
  The year the client moved out of this address.
- **residential_status** (string)
  The client's residential status when living at the address.
- **residential_status_other** (string)
  The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other.
- **lived_in_months** (integer)
  The number of months the client lived in the address.


[Powered by Bump.sh](https://bump.sh)