Headers

application/json

Body Required

Responses

POST /api/v1/client
curl \
 -X POST https://api.plannrcrm.com/api/v1/client \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"title":"Mr","first_name":"Gareth","middle_name":"Alex","last_name":"Thompson","maiden_name":"Thompson","email":"gareth@codepotato.co.uk","phone":"443330509960","assigned_adviser_uuid":"db2f032d-8e22-4ccc-8b40-fab40a1545d6","assigned_administrator_uuid":"eaa6e1a5-99cb-49d3-89fd-1afb7011e652","assigned_paraplanner_uuid":"86605e65-e71e-4ffa-8bdc-5e612922ac32","introduced_by_uuid":"8d7d9f74-403c-4f80-878a-2a0c018636c9","send_welcome_email":true,"date_of_birth":"1974-10-16","gender":"Male","ni_number":"AB 12 34 56 C","nickname":"G","target_retirement_age":60,"pronouns":"he/him","smoker_status":"non-smoker","residential_status":"settled","country_of_residence":"United Kingdom","marital_status":"married","is_vulnerable":"possibly","is_prospect":false,"prospect_converted_at":"2024-10-16T11:10:13+01:00","value":500000,"is_uk_resident":true,"is_uk_domicile":true,"expected_retirement_age":60,"state_retirement_age":60,"nationalities":["British","Romanian"],"vulnerability_details":"No vulnerabilities","third_party_offered":true,"procedure_adaptation":true,"adaption_details_notes":"Adaptation notes","client_preferences":"Prefers telephone calls in the morning.","current_state_of_health":"Fit and healthy","state_of_health_explanation":"Explanation of the current state of health.","cigarettes_daily":6,"smoker_since":"2014-10-16","long_term_care_needed":false,"long_term_care_notes":"Notes on the client's long term care.","has_will":false,"will_notes":"Notes on the client's will.","will_last_reviewed":"2024-10-15","has_power_of_attorney":true,"power_of_attorney_notes":"Notes on the client's power of attorney.","first_contact_date":"2024-09-16","units_of_alcohol_weekly":28,"height":186,"weight":220,"health_notes":"Notes on the client's health.","has_iht_planning":true,"iht_planning_notes":"Notes on the client's Inheritance Tax (IHT) planning.","has_gifted_family":true,"gift_notes":"Notes on the gifts.","is_anticipating_inheritance":true,"anticipating_inheritance_notes":"Notes on the client's inheritance anticipation/ expectations.","next_review_date":"2024-11-16","previous_review_date":"2024-09-16","anniversary_review_date":"2024-10-16","is_will_accurate":true,"will_executors":"string","will_location":"string","will_bequests_detail":"string","is_poa_registered_epa_or_lpa":"epa","are_poa_appointed_for_health_or_wealth":"health","poa_attorney_appointed_at":"2024-10-16T00:00:00+01:00","will_poa_details":"string","are_poa_documents_registered":true,"will_gifts_details":"string","groups":["127317f1-9cec-421c-9757-8c89e75ae2c6","75de597e-2b7e-4496-bc1a-56ce7291ef08"],"is_in_receipt_of_your_state_pension":true,"has_obtained_a_forecast":true,"date_of_forecast":"2024-10-16T11:10:13+01:00","projected_state_pension":50000,"years_of_national_insurance_contributions":5,"pension_notes":"string","status_uuid":"51d65217-1cec-45c8-9c79-7997ee1bee36","date_of_marriage":"2024-10-16","is_deceased":false,"deceased_at":"2024-10-16","is_married_to_partner":true,"checked_sanctions_at":"2024-10-16","lead_source":"LeadGen Company","write_to_whom":"Gareth","passport_number":"123456","do_not_contact_via_fax":false,"do_not_contact_via_mail":false,"do_not_contact_via_sms":false,"do_not_contact_via_email":false,"do_not_contact_via_telephone":false,"do_not_visit":false,"do_not_market":false,"client_regulatory_classification":"professional_client","external_reference":[{"reference":"AB123456","third_party":"nucleus"}]}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "title": "Mr",
  "first_name": "Gareth",
  "middle_name": "Alex",
  "last_name": "Thompson",
  "maiden_name": "Thompson",
  "email": "gareth@codepotato.co.uk",
  "phone": "443330509960",
  "assigned_adviser_uuid": "db2f032d-8e22-4ccc-8b40-fab40a1545d6",
  "assigned_administrator_uuid": "eaa6e1a5-99cb-49d3-89fd-1afb7011e652",
  "assigned_paraplanner_uuid": "86605e65-e71e-4ffa-8bdc-5e612922ac32",
  "introduced_by_uuid": "8d7d9f74-403c-4f80-878a-2a0c018636c9",
  "send_welcome_email": true,
  "date_of_birth": "1974-10-16",
  "gender": "Male",
  "ni_number": "AB 12 34 56 C",
  "nickname": "G",
  "target_retirement_age": 60,
  "pronouns": "he/him",
  "smoker_status": "non-smoker",
  "residential_status": "settled",
  "country_of_residence": "United Kingdom",
  "marital_status": "married",
  "is_vulnerable": "possibly",
  "is_prospect": false,
  "prospect_converted_at": "2024-10-16T11:10:13+01:00",
  "value": 500000,
  "is_uk_resident": true,
  "is_uk_domicile": true,
  "expected_retirement_age": 60,
  "state_retirement_age": 60,
  "nationalities": [
    "British",
    "Romanian"
  ],
  "vulnerability_details": "No vulnerabilities",
  "third_party_offered": true,
  "procedure_adaptation": true,
  "adaption_details_notes": "Adaptation notes",
  "client_preferences": "Prefers telephone calls in the morning.",
  "current_state_of_health": "Fit and healthy",
  "state_of_health_explanation": "Explanation of the current state of health.",
  "cigarettes_daily": 6,
  "smoker_since": "2014-10-16",
  "long_term_care_needed": false,
  "long_term_care_notes": "Notes on the client's long term care.",
  "has_will": false,
  "will_notes": "Notes on the client's will.",
  "will_last_reviewed": "2024-10-15",
  "has_power_of_attorney": true,
  "power_of_attorney_notes": "Notes on the client's power of attorney.",
  "first_contact_date": "2024-09-16",
  "units_of_alcohol_weekly": 28,
  "height": 186,
  "weight": 220,
  "health_notes": "Notes on the client's health.",
  "has_iht_planning": true,
  "iht_planning_notes": "Notes on the client's Inheritance Tax (IHT) planning.",
  "has_gifted_family": true,
  "gift_notes": "Notes on the gifts.",
  "is_anticipating_inheritance": true,
  "anticipating_inheritance_notes": "Notes on the client's inheritance anticipation/ expectations.",
  "next_review_date": "2024-11-16",
  "previous_review_date": "2024-09-16",
  "anniversary_review_date": "2024-10-16",
  "is_will_accurate": true,
  "will_executors": "string",
  "will_location": "string",
  "will_bequests_detail": "string",
  "is_poa_registered_epa_or_lpa": "epa",
  "are_poa_appointed_for_health_or_wealth": "health",
  "poa_attorney_appointed_at": "2024-10-16T00:00:00+01:00",
  "will_poa_details": "string",
  "are_poa_documents_registered": true,
  "will_gifts_details": "string",
  "groups": [
    "127317f1-9cec-421c-9757-8c89e75ae2c6",
    "75de597e-2b7e-4496-bc1a-56ce7291ef08"
  ],
  "is_in_receipt_of_your_state_pension": true,
  "has_obtained_a_forecast": true,
  "date_of_forecast": "2024-10-16T11:10:13+01:00",
  "projected_state_pension": 50000,
  "years_of_national_insurance_contributions": 5,
  "pension_notes": "string",
  "status_uuid": "51d65217-1cec-45c8-9c79-7997ee1bee36",
  "date_of_marriage": "2024-10-16",
  "is_deceased": false,
  "deceased_at": "2024-10-16",
  "is_married_to_partner": true,
  "checked_sanctions_at": "2024-10-16",
  "lead_source": "LeadGen Company",
  "write_to_whom": "Gareth",
  "passport_number": "123456",
  "do_not_contact_via_fax": false,
  "do_not_contact_via_mail": false,
  "do_not_contact_via_sms": false,
  "do_not_contact_via_email": false,
  "do_not_contact_via_telephone": false,
  "do_not_visit": false,
  "do_not_market": false,
  "client_regulatory_classification": "professional_client",
  "external_reference": [
    {
      "reference": "AB123456",
      "third_party": "nucleus"
    }
  ]
}
Response examples (200)
{
  "firm": {
    "tax": 17.5,
    "logo": "https://api.plannrcrm.com/images/plannr.jpg",
    "name": "Codepotato",
    "slug": "codepotato",
    "uuid": "b3a2b5ba-57f9-42d1-817f-bf54b6dc914b",
    "county": "Hampshire",
    "billing": {
      "invoice_email": "gareth@codepotato.co.uk",
      "invoice_county": "Hampshire",
      "invoice_country": "United Kingdom",
      "invoice_postcode": "PO7 7YH",
      "invoice_address_1": "Suite E, 5 The Briars",
      "invoice_address_2": "Waterberry Drive",
      "invoice_town_city": "Waterlooville"
    },
    "country": "United Kingdom",
    "postcode": "PO7 7YH",
    "address_1": "Suite E, 5 The Briars",
    "address_2": "Waterberry Drive",
    "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
    "month_end": 25,
    "town_city": "Waterlooville",
    "created_at": "2024-10-16T11:10:13+01:00",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "ip_whitelist": [
      "192.168.0.1",
      "127.0.0.1"
    ],
    "brand_colours": {
      "sidebar_text": "#ffffff",
      "sidebar_hover": "#0A0A42",
      "email_sub_text": "#ffffff",
      "sidebar_accent": "#36367E",
      "sidebar_active": "#53DBB8",
      "email_background": "#0E0E56",
      "email_button_text": "#ffffff",
      "sidebar_background": "#0E0E56",
      "sidebar_title_primary": "#FFC634",
      "email_button_background": "#36367E",
      "sidebar_title_secondary": "#ffffff",
      "sidebar_title_background": "#36367E",
      "email_logo_background_panel": "#36367E",
      "sidebar_title_secondary_hover": "#ffffff"
    },
    "is_subscribed": true,
    "regulatory_text": "Regulatory text",
    "addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
    "statement_frequency": "monthly",
    "task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
    "keep_deleted_files_for": 30,
    "welcome_paragraph_html": "<h1>Welcome.</h1>",
    "email_welcome_paragraph_html": "Welcome to Plannr!"
  },
  "name": "Gareth Thompson",
  "role": "client",
  "tags": [
    {
      "name": "Mortgage",
      "slug": "mortgage",
      "uuid": "5102f91c-3d6a-4552-91fc-e0d014197fc3",
      "colour": "#ef4582",
      "created_at": "2024-10-16T11:10:13+01:00",
      "updated_at": "2024-10-16T11:10:13+01:00"
    }
  ],
  "type": "client",
  "uuid": "4bf917a3-c8de-4fa5-a3dc-ff5a882172c1",
  "email": "gareth@codepotato.co.uk",
  "groups": [
    {
      "name": "finance",
      "slug": "finance",
      "uuid": "7e979a6f-fea8-4f36-9288-b2cd38b4cbac",
      "created_at": "2024-10-16T11:10:13+01:00",
      "updated_at": "2024-10-16T11:10:13+01:00",
      "participants": {
        "name": {
          "example": "Gareth Thompson",
          "description": "Name of the account"
        },
        "role": {
          "example": "client",
          "description": "Role of the account"
        },
        "uuid": {
          "example": "ccbb740d-fd40-4f1a-94f6-2fbb494496a3",
          "description": "UUID of the account"
        },
        "email": {
          "example": "gareth@codepotato.co.uk",
          "description": "Email of the account"
        },
        "last_name": {
          "example": "Thompson",
          "description": "Last name of the account"
        },
        "first_name": {
          "example": "Gareth",
          "description": "First name of the account"
        }
      },
      "participants_count": "3"
    }
  ],
  "owners": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Gareth Thompson",
      "role": "client",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "client",
      "uuid": "d2e6d6c6-373e-428a-b8c9-a15c9578c002",
      "email": "gareth@codepotato.co.uk",
      "groups": "App\\Http\\Resources\\GroupResource",
      "owners": "App\\Http\\Resources\\AccountResource",
      "last_name": "Thompson",
      "created_at": "2024-10-16T11:10:13+01:00",
      "first_name": "Gareth",
      "updated_at": "2024-10-16T11:10:13+01:00",
      "with_login": true,
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
      "introduced_by": "App\\Http\\Resources\\AccountResource",
      "primary_email": "App\\Http\\Resources\\ContactDetailResource",
      "can_be_deleted": "false",
      "assigned_adviser": "App\\Http\\Resources\\AccountResource",
      "next_review_date": "2024-10-16T11:10:13+01:00",
      "has_joint_account": true,
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "first_contact_date": "2024-10-16T11:10:13+01:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
      "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
      "previous_review_date": "2024-10-16T11:10:13+01:00",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "anniversary_review_date": "2024-10-16T11:10:13+01:00"
    }
  ],
  "last_name": "Thompson",
  "created_at": "2024-10-16T11:10:13+01:00",
  "first_name": "Gareth",
  "updated_at": "2024-10-16T11:10:13+01:00",
  "with_login": true,
  "custom_fields": [
    {
      "name": "Favourite Drink",
      "type": "string",
      "uuid": "5e8f8803-15ef-473a-9b1d-9086c849d5d1",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2024-10-16T11:10:13+01:00",
      "updated_at": "2024-10-16T11:10:13+01:00",
      "is_required": false,
      "selection_options": [
        "Coffee",
        "Tea",
        "Water"
      ]
    }
  ],
  "introduced_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "6ebe99a1-c02e-4273-b0e2-c5fbf94f293a",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:13+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2024-10-16T11:10:13+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:13+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:13+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:13+01:00"
  },
  "primary_email": {
    "name": "Work number",
    "type": "phone_number",
    "uuid": "2386ccf2-3df3-44c0-883e-9a0df334c98a",
    "value": "+443330903630",
    "account": "App\\Http\\Resources\\AccountResource",
    "primary": true,
    "created_at": "2024-10-16T11:10:13+01:00",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "phone_number_meta": {
      "country": "GB",
      "formatted": "0333 090 3630"
    }
  },
  "can_be_deleted": "false",
  "assigned_adviser": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "636868f7-7ffb-49ba-83ca-96e3f0c541e2",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:13+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2024-10-16T11:10:13+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:13+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:13+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:13+01:00"
  },
  "next_review_date": "2024-10-16T11:10:13+01:00",
  "has_joint_account": true,
  "current_time_entry": {
    "name": "Research",
    "uuid": "0f7988dc-c358-4be4-af0e-a8cad26d3580",
    "end_date": "2024-10-16T11:10:13+01:00",
    "is_active": "1",
    "trackable": "Client",
    "start_date": "2024-10-16T11:10:13+01:00"
  },
  "first_contact_date": "2024-10-16T11:10:13+01:00",
  "external_references": [
    {
      "uuid": "993f2e3a-0347-4fbf-9c57-cad155278545",
      "reference": "AB123456",
      "created_at": "2024-10-16T11:10:13+01:00",
      "updated_at": "2024-10-16T11:10:13+01:00",
      "third_party": "nucleus"
    }
  ],
  "assigned_paraplanner": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "9082aaef-4943-4dab-8d42-2e15772fe5b2",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:13+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2024-10-16T11:10:13+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:13+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:13+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:13+01:00"
  },
  "previous_review_date": "2024-10-16T11:10:13+01:00",
  "primary_phone_number": {
    "name": "Work number",
    "type": "phone_number",
    "uuid": "79b5fbaf-c4aa-47df-95ef-40cf461f30f7",
    "value": "+443330903630",
    "account": "App\\Http\\Resources\\AccountResource",
    "primary": true,
    "created_at": "2024-10-16T11:10:13+01:00",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "phone_number_meta": {
      "country": "GB",
      "formatted": "0333 090 3630"
    }
  },
  "assigned_administrator": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "770a8e0d-62d8-4679-aba5-9a352021594e",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:13+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2024-10-16T11:10:13+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:13+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:13+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:13+01:00"
  },
  "anniversary_review_date": "2024-10-16T11:10:13+01:00"
}