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":"dafe23d2-019a-4de0-8e27-99a3c0000838","assigned_administrator_uuid":"882ee19c-9495-4eb1-ac75-22b4cb8030ca","assigned_paraplanner_uuid":"ced2825e-2fbb-4957-8c09-45cb841fe481","introduced_by_uuid":"be60c081-e8cd-4861-9602-b5a8ff69b21d","send_welcome_email":true,"date_of_birth":"1974-11-20","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-11-20T13:24:00+00: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-11-20","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-11-19","has_power_of_attorney":true,"power_of_attorney_notes":"Notes on the client's power of attorney.","first_contact_date":"2024-10-20","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-12-20","previous_review_date":"2024-10-20","anniversary_review_date":"2024-11-20","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-11-20T00:00:00+00:00","will_poa_details":"string","are_poa_documents_registered":true,"will_gifts_details":"string","groups":["886182e5-7875-4616-811c-30717a0dd34b","807b79cf-2198-4dd5-9353-9ecee1a7d66b"],"is_in_receipt_of_your_state_pension":true,"has_obtained_a_forecast":true,"date_of_forecast":"2024-11-20T13:24:00+00:00","projected_state_pension":50000,"years_of_national_insurance_contributions":5,"pension_notes":"string","status_uuid":"b8aa4e77-ce53-44fa-881a-5e1989da1772","date_of_marriage":"2024-11-20","is_deceased":false,"deceased_at":"2024-11-20","is_married_to_partner":true,"checked_sanctions_at":"2024-11-20","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": "dafe23d2-019a-4de0-8e27-99a3c0000838",
  "assigned_administrator_uuid": "882ee19c-9495-4eb1-ac75-22b4cb8030ca",
  "assigned_paraplanner_uuid": "ced2825e-2fbb-4957-8c09-45cb841fe481",
  "introduced_by_uuid": "be60c081-e8cd-4861-9602-b5a8ff69b21d",
  "send_welcome_email": true,
  "date_of_birth": "1974-11-20",
  "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-11-20T13:24:00+00: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-11-20",
  "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-11-19",
  "has_power_of_attorney": true,
  "power_of_attorney_notes": "Notes on the client's power of attorney.",
  "first_contact_date": "2024-10-20",
  "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-12-20",
  "previous_review_date": "2024-10-20",
  "anniversary_review_date": "2024-11-20",
  "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-11-20T00:00:00+00:00",
  "will_poa_details": "string",
  "are_poa_documents_registered": true,
  "will_gifts_details": "string",
  "groups": [
    "886182e5-7875-4616-811c-30717a0dd34b",
    "807b79cf-2198-4dd5-9353-9ecee1a7d66b"
  ],
  "is_in_receipt_of_your_state_pension": true,
  "has_obtained_a_forecast": true,
  "date_of_forecast": "2024-11-20T13:24:00+00:00",
  "projected_state_pension": 50000,
  "years_of_national_insurance_contributions": 5,
  "pension_notes": "string",
  "status_uuid": "b8aa4e77-ce53-44fa-881a-5e1989da1772",
  "date_of_marriage": "2024-11-20",
  "is_deceased": false,
  "deceased_at": "2024-11-20",
  "is_married_to_partner": true,
  "checked_sanctions_at": "2024-11-20",
  "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": "3670cc56-78b3-4f3f-9f25-f95fddabb9d2",
    "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-11-20T13:24:00+00:00",
    "updated_at": "2024-11-20T13:24:00+00: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": "b4c589d4-f08f-4f88-b8d5-bff12fa03e60",
      "colour": "#ef4582",
      "created_at": "2024-11-20T13:24:00+00:00",
      "updated_at": "2024-11-20T13:24:00+00:00"
    }
  ],
  "type": "client",
  "uuid": "a75d4a68-8320-44cf-8b21-f1d4ae9317cb",
  "email": "gareth@codepotato.co.uk",
  "groups": [
    {
      "name": "finance",
      "slug": "finance",
      "uuid": "0d4daff3-2d1f-4112-9bac-a53ac135a937",
      "created_at": "2024-11-20T13:24:00+00:00",
      "updated_at": "2024-11-20T13:24:00+00:00",
      "participants": {
        "name": {
          "example": "Gareth Thompson",
          "description": "Name of the account"
        },
        "role": {
          "example": "client",
          "description": "Role of the account"
        },
        "uuid": {
          "example": "7d6a257a-9a32-4e17-b846-fc996f17bad8",
          "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": "b55474ee-00da-46e4-9b68-566c47bd4fef",
      "email": "gareth@codepotato.co.uk",
      "groups": "App\\Http\\Resources\\GroupResource",
      "owners": "App\\Http\\Resources\\AccountResource",
      "last_name": "Thompson",
      "created_at": "2024-11-20T13:24:00+00:00",
      "first_name": "Gareth",
      "updated_at": "2024-11-20T13:24:00+00: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-11-20T13:24:00+00:00",
      "has_joint_account": true,
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "first_contact_date": "2024-11-20T13:24:00+00:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
      "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
      "previous_review_date": "2024-11-20T13:24:00+00:00",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "anniversary_review_date": "2024-11-20T13:24:00+00:00"
    }
  ],
  "last_name": "Thompson",
  "created_at": "2024-11-20T13:24:00+00:00",
  "first_name": "Gareth",
  "updated_at": "2024-11-20T13:24:00+00:00",
  "with_login": true,
  "custom_fields": [
    {
      "name": "Favourite Drink",
      "type": "string",
      "uuid": "c5055605-5db6-41f7-9529-96383c142021",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2024-11-20T13:24:00+00:00",
      "updated_at": "2024-11-20T13:24:00+00: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": "4e745ad2-4ad0-4f01-ba0e-846c0bbc856a",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:24:00+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:24:00+00: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-11-20T13:24:00+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:24:00+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:24:00+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:24:00+00:00"
  },
  "primary_email": {
    "name": "Work number",
    "type": "phone_number",
    "uuid": "4b3ddea9-36b6-4e85-99a7-0778688a8ffd",
    "value": "+443330903630",
    "accounts": "App\\Http\\Resources\\AccountResource",
    "created_at": "2024-11-20T13:24:00+00:00",
    "updated_at": "2024-11-20T13:24:00+00: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": "b6b08a2d-4173-49a3-9b69-9ba1e7b2e4e7",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:24:00+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:24:00+00: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-11-20T13:24:00+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:24:00+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:24:00+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:24:00+00:00"
  },
  "next_review_date": "2024-11-20T13:24:00+00:00",
  "has_joint_account": true,
  "current_time_entry": {
    "name": "Research",
    "uuid": "38df30e8-c24f-4c7c-8c03-ed6c3c1a4ef4",
    "end_date": "2024-11-20T13:24:00+00:00",
    "is_active": "1",
    "trackable": "Client",
    "start_date": "2024-11-20T13:24:00+00:00"
  },
  "first_contact_date": "2024-11-20T13:24:00+00:00",
  "external_references": [
    {
      "uuid": "2e2eeed4-a639-43c0-bec2-f3b315a31af1",
      "reference": "AB123456",
      "created_at": "2024-11-20T13:24:00+00:00",
      "updated_at": "2024-11-20T13:24:00+00:00",
      "third_party": "nucleus"
    }
  ],
  "assigned_paraplanner": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "8fc5d18a-8bcc-4d09-bf74-d924884dad75",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:24:00+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:24:00+00: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-11-20T13:24:00+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:24:00+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:24:00+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:24:00+00:00"
  },
  "previous_review_date": "2024-11-20T13:24:00+00:00",
  "primary_phone_number": {
    "name": "Work number",
    "type": "phone_number",
    "uuid": "45303743-f444-428e-894a-da7c399ec519",
    "value": "+443330903630",
    "accounts": "App\\Http\\Resources\\AccountResource",
    "created_at": "2024-11-20T13:24:00+00:00",
    "updated_at": "2024-11-20T13:24:00+00: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": "98d5af44-8358-4e2e-894d-4480f199ba37",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:24:00+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:24:00+00: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-11-20T13:24:00+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:24:00+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:24:00+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:24:00+00:00"
  },
  "anniversary_review_date": "2024-11-20T13:24:00+00:00"
}