Create an address Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}
Close
POST /api/v2/addresses
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string
application/json

Body

  • account_uuids array[string(uuid)] Required

    The UUIDs of the accounts who should own the address. These must only be client accounts.

  • primary_account_uuids array[string(uuid)]

    The UUIDs of the accounts who should have the address as their primary 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.

  • name string

    Name of the address

  • address_1 string

    First line of the address

  • address_2 string

    Second line of the address

  • address_3 string

    Third line of the address

  • address_4 string

    Fourth line of the address

  • town_city string

    Town/City

  • county string

    County

  • postcode string

    Postcode

  • country string

    Country

  • move_in_date string

    Move in date

  • 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.

    Value Description
    homeowner Homeowner
    renting Renting
    living_with_parents Living With Parents
    other Other

    Values are homeowner, renting, living_with_parents, or other.

  • 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 application/json
    Hide response attributes Show response attributes object
    • uuid string
    • created_at string
    • updated_at string
    • name string
    • address_1 string
    • address_2 string
    • address_3 string
    • address_4 string
    • town_city string
    • county string
    • postcode string
    • country string
    • accounts object
      Hide accounts attributes Show accounts attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references object
        Hide external_references attributes Show external_references attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • third_party

          The third party provider with the reference.

        • reference

          The third party reference.

    • primary_accounts object
      Hide primary_accounts attributes Show primary_accounts attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references object
        Hide external_references attributes Show external_references attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • third_party

          The third party provider with the reference.

        • reference

          The third party reference.

    • moved_in_month integer
    • moved_in_year integer
    • moved_out_month integer
    • moved_out_year integer
    • residential_status string
    • residential_status_other string
    • lived_in_months integer
  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • message string Required

      A human-readable description of the error.

    • errors object

      Validation messages keyed by the field that failed.

      Hide errors attribute Show errors attribute object
      • * array[string] Additional properties
POST /api/v2/addresses 
curl \
 --request POST 'https://api.plannrcrm.com/api/v2/addresses' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{
  "account_uuids": [
    "bbda790f-79e8-413a-991b-c1cff48678cb",
    "307ae4fc-a826-4183-818a-fae7cea95542",
    "212213a1-081f-4b61-91b2-94d61be8f422"
  ],
  "primary_account_uuids": [
    "8b90e9c5-b0eb-4e36-83fa-59cb75e0746b",
    "d2f02e15-268e-4863-87b9-4497cb68cce6",
    "0c1fbc36-2f19-40e8-ac13-96c6a8fa60e7"
  ],
  "is_primary": true,
  "name": "Work Address",
  "address_1": "Suite E",
  "address_2": "5 The Briars",
  "address_3": "Waterberry Drive",
  "address_4": "The Innovative Centre",
  "town_city": "Waterlooville",
  "county": "Hampshire",
  "postcode": "PO7 7YH",
  "country": "United Kingdom",
  "move_in_date": "2024-06-20",
  "moved_in_month": 6,
  "moved_in_year": 2022,
  "moved_out_month": 1,
  "moved_out_year": 2024,
  "residential_status": "homeowner",
  "residential_status_other": "Non-tenant occupier"
}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "account_uuids": [
    "bbda790f-79e8-413a-991b-c1cff48678cb",
    "307ae4fc-a826-4183-818a-fae7cea95542",
    "212213a1-081f-4b61-91b2-94d61be8f422"
  ],
  "primary_account_uuids": [
    "8b90e9c5-b0eb-4e36-83fa-59cb75e0746b",
    "d2f02e15-268e-4863-87b9-4497cb68cce6",
    "0c1fbc36-2f19-40e8-ac13-96c6a8fa60e7"
  ],
  "is_primary": true,
  "name": "Work Address",
  "address_1": "Suite E",
  "address_2": "5 The Briars",
  "address_3": "Waterberry Drive",
  "address_4": "The Innovative Centre",
  "town_city": "Waterlooville",
  "county": "Hampshire",
  "postcode": "PO7 7YH",
  "country": "United Kingdom",
  "move_in_date": "2024-06-20",
  "moved_in_month": 6,
  "moved_in_year": 2022,
  "moved_out_month": 1,
  "moved_out_year": 2024,
  "residential_status": "homeowner",
  "residential_status_other": "Non-tenant occupier"
}
Response examples (201) 
{
  "uuid": "08de8708-bb42-4aac-9170-9342779f10f7",
  "created_at": "2026-10-09T13:38:25+01:00",
  "updated_at": "2026-10-09T13:38:25+01:00",
  "name": "Work Address",
  "address_1": "Suite E, 5 The Briars",
  "address_2": "Waterberry Drive",
  "address_3": "The Innovative Centre",
  "address_4": "Waterlooville",
  "town_city": "Waterlooville",
  "county": "Hampshire",
  "postcode": "PO7 7YH",
  "country": "United Kingdom",
  "accounts": {
    "uuid": "7575c1b8-78f8-47fa-8404-9d16d4f800a4",
    "created_at": "2026-10-09T13:38:25+01:00",
    "updated_at": "2026-10-09T13:38:25+01:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "external_references": {
      "uuid": "8293507c-76c3-4d3a-9ad1-991f2d2f4031",
      "created_at": "2026-10-09T13:38:28+01:00",
      "updated_at": "2026-10-09T13:38:28+01:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "primary_accounts": {
    "uuid": "4fff90d8-7160-4e84-8ef7-827069a28a7d",
    "created_at": "2026-10-09T13:38:25+01:00",
    "updated_at": "2026-10-09T13:38:25+01:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "external_references": {
      "uuid": "8293507c-76c3-4d3a-9ad1-991f2d2f4031",
      "created_at": "2026-10-09T13:38:28+01:00",
      "updated_at": "2026-10-09T13:38:28+01:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "moved_in_month": 6,
  "moved_in_year": 2022,
  "moved_out_month": 1,
  "moved_out_year": 2024,
  "residential_status": "homeowner",
  "residential_status_other": "homeowner",
  "lived_in_months": 19
}
Response examples (422) 
{
  "message": "The given data was invalid.",
  "errors": {
    "field": [
      "The field is invalid."
    ]
  }
}