PUT
/api/v1/account/{uuid}
curl \
--request PUT 'https://api.plannrcrm.com/api/v1/account/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"Client":[{"title":{"type":"string","example":"Mr","required":false,"description":"Title"},"value":{"type":"integer","example":500000,"required":false,"description":"The value of the client in penny format. E.g £5,000 would be 500000."},"gender":{"type":"string","example":"Male","required":false,"description":"Gender. Possible values are: male, female, non-binary, transgender, intersex, other and unknown"},"groups":{"type":"array","example":["e118137f-7923-4429-92f7-dc42f63f9007","44cfe99c-0574-4157-bf62-23eb358fd853"],"required":false,"description":"Group UUIDs to sync client to. Null can be provided to clear a clients groups."},"height":{"type":"integer","example":186,"required":false,"description":"The height of the client in centimeters."},"weight":{"type":"integer","example":220,"required":false,"description":"The weight of the client in pounds."},"has_will":{"type":"boolean","example":true,"required":false,"description":"Whether the client has a will or not."},"nickname":{"type":"string","example":"Garth","required":false,"description":"preferred nickname of the client"},"pronouns":{"type":"string","example":"he/him","required":false,"description":"Pronouns"},"last_name":{"type":"string","example":"Thompson","required":false,"description":"Last name"},"ni_number":{"type":"string","example":"AB 12 34 56 C","required":false,"description":"National Insurance Number"},"first_name":{"type":"string","example":"Gareth","required":false,"description":"First name"},"gift_notes":{"type":"string","example":"Notes on the gifts.","required":false,"description":"Notes on the gifts."},"will_notes":{"type":"string","example":"Notes on the client's will.","required":false,"description":"Notes on the client's will."},"deceased_at":{"type":"date","example":"2025-06-26","required":false,"description":"Date of death"},"entity_name":{"type":"string","example":"Plannr Ltd","required":false,"description":"Entity name for shared account types"},"inactive_at":{"type":"date","example":"2025-06-26","required":false,"description":"Inactive from date"},"is_deceased":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client is deceased"},"is_prospect":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client is a prospect or not."},"lead_source":{"type":"string","example":"LeadGen Company","required":false,"description":"Marks the lead source of the client"},"maiden_name":{"type":"string","example":"Thompson","required":false,"description":"Maiden name."},"middle_name":{"type":"string","example":"Alex","required":false,"description":"Middle name."},"status_uuid":{"type":"string","example":"3f1993d5-4438-48ec-a383-590498c12914","required":false,"description":"The status of the client."},"do_not_visit":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be visited"},"health_notes":{"type":"string","example":"Notes on the client's health.","required":false,"description":"Notes on the client's health."},"smoker_since":{"type":"date","example":"2015-06-26","required":false,"description":"The date of when the client started smoking."},"date_of_birth":{"type":"date","example":"1975-06-26","required":false,"description":"Date of birth"},"do_not_market":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be visited"},"is_vulnerable":{"type":"string","example":"possibly","required":false,"description":"whether the client is vulnerable. Possible values are: \"yes\", \"no\", and \"possibly\""},"nationalities":{"type":"array","example":["British","Romanian"],"required":false,"description":"Nationalities of the client. You can use the api/v1/static/nationalities endpoint to get our list."},"pension_notes":{"type":"string","example":"","required":false,"description":"Notes on the pension"},"smoker_status":{"type":"string","example":"non-smoker","required":false,"description":"Smoker Status. Possible values are: smoker, non-smoker, vaper, ex-smoker, never-smoked, unknown"},"will_location":{"type":"string","example":"","required":false,"description":"Where is the will stored?"},"write_to_whom":{"type":"string","example":"Gareth","required":false,"description":"Marks the name of the client to write to"},"is_uk_domicile":{"type":"boolean","example":true,"required":false,"description":"Whether the client is a UK domicile or not."},"is_uk_resident":{"type":"boolean","example":true,"required":false,"description":"Whether the client is a UK resident or not."},"marital_status":{"type":"string","example":"married","required":false,"description":"Marital status. Possible values are: single, cohabiting, married, divorced, civil-partnership, dissolved-civil-partnership, widowed, separated, engaged, in-relationship, other, unknown"},"will_executors":{"type":"string","example":"","required":false,"description":"Who are the executors?"},"passport_number":{"type":"string","example":"123456","required":false,"description":"The passport number of the client"},"cigarettes_daily":{"type":"integer","example":6,"required":false,"description":"The amount of cigarettes the client smokes a day."},"date_of_forecast":{"type":"date","example":"2025-06-26T11:37:02+01:00","required":false,"description":"What is the date of the obtained forecast"},"date_of_marriage":{"type":"date","example":"2025-06-26","required":false,"description":"Date of marriage"},"has_iht_planning":{"type":"boolean","example":true,"required":false,"description":"Whether the client has Inheritance Tax (IHT) planning or not."},"is_will_accurate":{"type":"boolean","example":true,"required":false,"description":"Does your current will reflect your wishes?"},"next_review_date":{"type":"date","example":"2025-07-26","required":false,"description":"Date of next review"},"will_poa_details":{"type":"string","example":"","required":false,"description":"Who are the Attorney’s?"},"has_gifted_family":{"type":"boolean","example":true,"required":false,"description":"Whether the client has gifted the family."},"client_preferences":{"type":"string","example":"Prefers telephone calls in the morning.","required":false,"description":"Any client preferences."},"first_contact_date":{"type":"date","example":"2025-05-26","required":false,"description":"The date of the first contact."},"iht_planning_notes":{"type":"string","example":"Notes on the client's Inheritance Tax (IHT) planning.","required":false,"description":"Notes on the client's Inheritance Tax (IHT) planning."},"introduced_by_uuid":{"type":"string","example":"c9bb5bb1-c4ec-414b-9f67-2fd4dc64ba30","required":false,"description":"The UUID of the introducer for this client"},"primary_email_uuid":{"type":"string","example":"4e893b09-00c0-4572-99ed-8c32d85df60c","required":false,"description":"uuid of the primary email contact detail"},"residential_status":{"type":"string","example":"settled","required":false,"description":"Residential status"},"will_gifts_details":{"type":"string","example":"","required":false,"description":"Notes of gifts"},"will_last_reviewed":{"type":"date","example":"2025-06-26","required":false,"description":"The date of the last time the will's been reviewed."},"third_party_offered":{"type":"boolean","example":true,"required":false,"description":"Whether the client has been offered any third party."},"checked_sanctions_at":{"type":"date","example":"2025-06-26","required":false,"description":"Date the client was checked for sanctions"},"country_of_residence":{"type":"string","example":"United Kingdom","required":false,"description":"Country of residence"},"long_term_care_notes":{"type":"string","example":"Notes on the client's long term care.","required":false,"description":"Notes on the client's long term care."},"previous_review_date":{"type":"date","example":"2025-05-26","required":false,"description":"Date of previous review"},"primary_address_uuid":{"type":"string","example":"0b2c9012-6e43-4244-ae1b-bae2408377c5","required":false,"description":"uuid of the primary address"},"procedure_adaptation":{"type":"boolean","example":false,"required":false,"description":"Whether any procedures need to be adapted to the client."},"state_retirement_age":{"type":"integer","example":60,"required":false,"description":"The state retirement age."},"will_bequests_detail":{"type":"string","example":"","required":false,"description":"Details of any Bequests"},"assigned_adviser_uuid":{"type":"string","example":"e6579c47-dc23-471e-980d-1b24aeae692d","required":false,"description":"The UUID of the employee that the client directly reports to"},"has_power_of_attorney":{"type":"boolean","example":true,"required":false,"description":"Whether the client has power of attorney."},"is_married_to_partner":{"type":"boolean","example":true,"required":false,"description":"Denotes if the client is married to their partner"},"long_term_care_needed":{"type":"boolean","example":false,"required":false,"description":"Whether the client required long term care."},"prospect_converted_at":{"type":"date","example":"2025-06-26T11:37:02+01:00","required":false,"description":"The datetime when the prospect was converted into a client."},"target_retirement_age":{"type":"integer","example":60,"required":false,"description":"Targest retirement age."},"vulnerability_details":{"type":"string","example":"No vulnerabilities","required":false,"description":"Any details regarding the client's vulnerabilities."},"adaption_details_notes":{"type":"boolean","example":"Adaptation notes","required":false,"description":"Any notes regarding adaptations"},"do_not_contact_via_fax":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be contacted via fax"},"do_not_contact_via_sms":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be contacted via SMS"},"anniversary_review_date":{"type":"date","example":"2025-06-26","required":false,"description":"Anniversary review date"},"current_life_stage_uuid":{"type":"string","example":"3fc478e5-4347-4d2a-985d-b7998dfbf148","required":false,"description":"The clients current life stage for expenditure."},"current_state_of_health":{"type":"string","example":"Fit and healthy","required":false,"description":"The client's current state of health."},"do_not_contact_via_mail":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be contacted via mail"},"expected_retirement_age":{"type":"integer","example":60,"required":false,"description":"The expected retirement age."},"has_obtained_a_forecast":{"type":"boolean","example":true,"required":false,"description":"Have you recently obtained a forecast"},"power_of_attorney_notes":{"type":"string","example":"Notes on the client's power of attorney.","required":false,"description":"Notes on the client's power of attorney."},"projected_state_pension":{"type":"integer","example":50000,"required":false,"description":"What is the projected State Pension"},"units_of_alcohol_weekly":{"type":"integer","example":28,"required":false,"description":"The units of alcohol digested weekly."},"do_not_contact_via_email":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be contacted via email"},"assigned_paraplanner_uuid":{"type":"string","example":"210e92d0-9799-4f7c-973f-afbbad56ce6e","required":false,"description":"The UUID of the paraplanner employee that the client has been assigned"},"poa_attorney_appointed_at":{"type":"date","example":"2025-06-26T00:00:00+01:00","required":false,"description":"When were the Attorney’s appointed?"},"primary_phone_number_uuid":{"type":"string","example":"590b8fc4-2dd9-4f1e-9dcd-ed3d4bb96319","required":false,"description":"uuid of the primary phone number contact detail"},"assigned_administrator_uuid":{"type":"string","example":"c57f2f18-bb5e-4fef-bce5-83a00ba060b4","required":false,"description":"The UUID of the adviser employee that the client has been assigned"},"is_anticipating_inheritance":{"type":"boolean","example":true,"required":false,"description":"Whether the client is anticipating/ expecting any inheritance."},"state_of_health_explanation":{"type":"string","example":"Explanation of the current state of health.","required":false,"description":"Explanation of the current state of health."},"are_poa_documents_registered":{"type":"boolean","example":true,"required":false,"description":"Are the documents registered?"},"do_not_contact_via_telephone":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be contacted via telephone"},"is_poa_registered_epa_or_lpa":{"type":"string","example":"epa","required":false,"description":"Is the Power of Attorney Registered as a EPA or LPA"},"anticipating_inheritance_notes":{"type":"string","example":"Notes on the client's inheritance anticipation/ expectations.","required":false,"description":"Notes on the client's inheritance anticipation/ expectations."},"last_used_nicotine_products_date":{"type":"date","example":"2024-06-26","required":false,"description":"The date of the last time the client used nicotine products."},"is_in_receipt_of_your_state_pension":{"type":"boolean","example":true,"required":false,"description":"Are you in receipt of your State Pension"},"are_poa_appointed_for_health_or_wealth":{"type":"string","example":"health","required":false,"description":"Are the Attorneys appointed for Health, Wealth or Both?"},"years_of_national_insurance_contributions":{"type":"integer","example":5,"required":false,"description":"How many years have you made Nation Insurance Contributions"}}],"Employee":[{"role":{"type":"string","example":"owner","required":false,"description":"The role of the employee."},"email":{"type":"string","example":"gareth.thompson@plannrcrm.com","required":false,"description":"The email of the employee. Required when with_login is present."},"groups":{"type":"array","example":["3214f0b7-c82c-44ca-a14f-77133f281157","c548eb83-fb64-472b-b7ec-7672cc3fd4cc"],"required":false,"description":"Group UUIDs to sync employee to. Null can be provided to clear an employees groups"},"last_name":{"type":"string","example":"Thompson","required":false,"description":"The last name of the employee."},"first_name":{"type":"string","example":"Gareth","required":false,"description":"The first name of the employee."},"advice_type":{"type":"string","example":"independent","required":false,"description":"Employee's RMAR advice type"},"departments":{"type":"array","example":["paraplanner","adviser"],"required":false,"description":"The departments the employee is part of"},"inactive_at":{"type":"date","example":"2025-06-26","required":false,"description":"Inactive from date"},"adviser_split_uuid":{"type":"string","example":"10ff3fd7-b84f-4d4b-a0f3-e43ed3d8a276","required":false,"description":"Adviser split"},"meeting_booking_url":{"type":"string","example":"https://calendly.com/gareth-codepotato","required":false,"description":"Employee's meeting booking URL"},"assigned_adviser_uuid":{"type":"string","example":"d8cdd850-fee8-4f02-9cd5-1b606f5b2046","required":false,"description":"The uuid of the senior employee that the employee directly reports to"}}],"Introducer":[{"title":{"type":"string","example":"Mr","required":false,"description":"Title"},"groups":{"type":"array","example":["e3675bf5-3c09-4460-b2cd-03ab9aebdaf0","1672b5fa-bff9-429d-9dd6-73b6397d0af4"],"required":false,"description":"Group UUIDs to sync introducer to. Null can be provided to clear an introducers groups"},"last_name":{"type":"string","example":"Stanton","required":false,"description":"Last name"},"first_name":{"type":"string","example":"Patrick","required":false,"description":"First name"},"entity_name":{"type":"string","example":"PatrickCo","required":false,"description":"Entity/business name"},"inactive_at":{"type":"date","example":"2025-06-26","required":false,"description":"Inactive from date"},"assigned_adviser_uuid":{"type":"string","example":"a681f2c7-5028-4a19-b8a9-257f1d0cad56","required":false,"description":"UUID of the account that this account reports to"},"charge_split_schema_uuid":{"type":"string","example":"37efc11c-a400-4c40-9a44-ce37059d3244","required":false,"description":"Charge split schema that is always used when adding a charge split for this introducer"}}]}'
Request examples
{
"Client": [
{
"title": {
"type": "string",
"example": "Mr",
"required": false,
"description": "Title"
},
"value": {
"type": "integer",
"example": 500000,
"required": false,
"description": "The value of the client in penny format. E.g £5,000 would be 500000."
},
"gender": {
"type": "string",
"example": "Male",
"required": false,
"description": "Gender. Possible values are: male, female, non-binary, transgender, intersex, other and unknown"
},
"groups": {
"type": "array",
"example": [
"e118137f-7923-4429-92f7-dc42f63f9007",
"44cfe99c-0574-4157-bf62-23eb358fd853"
],
"required": false,
"description": "Group UUIDs to sync client to. Null can be provided to clear a clients groups."
},
"height": {
"type": "integer",
"example": 186,
"required": false,
"description": "The height of the client in centimeters."
},
"weight": {
"type": "integer",
"example": 220,
"required": false,
"description": "The weight of the client in pounds."
},
"has_will": {
"type": "boolean",
"example": true,
"required": false,
"description": "Whether the client has a will or not."
},
"nickname": {
"type": "string",
"example": "Garth",
"required": false,
"description": "preferred nickname of the client"
},
"pronouns": {
"type": "string",
"example": "he/him",
"required": false,
"description": "Pronouns"
},
"last_name": {
"type": "string",
"example": "Thompson",
"required": false,
"description": "Last name"
},
"ni_number": {
"type": "string",
"example": "AB 12 34 56 C",
"required": false,
"description": "National Insurance Number"
},
"first_name": {
"type": "string",
"example": "Gareth",
"required": false,
"description": "First name"
},
"gift_notes": {
"type": "string",
"example": "Notes on the gifts.",
"required": false,
"description": "Notes on the gifts."
},
"will_notes": {
"type": "string",
"example": "Notes on the client's will.",
"required": false,
"description": "Notes on the client's will."
},
"deceased_at": {
"type": "date",
"example": "2025-06-26",
"required": false,
"description": "Date of death"
},
"entity_name": {
"type": "string",
"example": "Plannr Ltd",
"required": false,
"description": "Entity name for shared account types"
},
"inactive_at": {
"type": "date",
"example": "2025-06-26",
"required": false,
"description": "Inactive from date"
},
"is_deceased": {
"type": "boolean",
"example": false,
"required": false,
"description": "Denotes if the client is deceased"
},
"is_prospect": {
"type": "boolean",
"example": false,
"required": false,
"description": "Denotes if the client is a prospect or not."
},
"lead_source": {
"type": "string",
"example": "LeadGen Company",
"required": false,
"description": "Marks the lead source of the client"
},
"maiden_name": {
"type": "string",
"example": "Thompson",
"required": false,
"description": "Maiden name."
},
"middle_name": {
"type": "string",
"example": "Alex",
"required": false,
"description": "Middle name."
},
"status_uuid": {
"type": "string",
"example": "3f1993d5-4438-48ec-a383-590498c12914",
"required": false,
"description": "The status of the client."
},
"do_not_visit": {
"type": "boolean",
"example": false,
"required": false,
"description": "Denotes if the client can be visited"
},
"health_notes": {
"type": "string",
"example": "Notes on the client's health.",
"required": false,
"description": "Notes on the client's health."
},
"smoker_since": {
"type": "date",
"example": "2015-06-26",
"required": false,
"description": "The date of when the client started smoking."
},
"date_of_birth": {
"type": "date",
"example": "1975-06-26",
"required": false,
"description": "Date of birth"
},
"do_not_market": {
"type": "boolean",
"example": false,
"required": false,
"description": "Denotes if the client can be visited"
},
"is_vulnerable": {
"type": "string",
"example": "possibly",
"required": false,
"description": "whether the client is vulnerable. Possible values are: \"yes\", \"no\", and \"possibly\""
},
"nationalities": {
"type": "array",
"example": [
"British",
"Romanian"
],
"required": false,
"description": "Nationalities of the client. You can use the api/v1/static/nationalities endpoint to get our list."
},
"pension_notes": {
"type": "string",
"example": "",
"required": false,
"description": "Notes on the pension"
},
"smoker_status": {
"type": "string",
"example": "non-smoker",
"required": false,
"description": "Smoker Status. Possible values are: smoker, non-smoker, vaper, ex-smoker, never-smoked, unknown"
},
"will_location": {
"type": "string",
"example": "",
"required": false,
"description": "Where is the will stored?"
},
"write_to_whom": {
"type": "string",
"example": "Gareth",
"required": false,
"description": "Marks the name of the client to write to"
},
"is_uk_domicile": {
"type": "boolean",
"example": true,
"required": false,
"description": "Whether the client is a UK domicile or not."
},
"is_uk_resident": {
"type": "boolean",
"example": true,
"required": false,
"description": "Whether the client is a UK resident or not."
},
"marital_status": {
"type": "string",
"example": "married",
"required": false,
"description": "Marital status. Possible values are: single, cohabiting, married, divorced, civil-partnership, dissolved-civil-partnership, widowed, separated, engaged, in-relationship, other, unknown"
},
"will_executors": {
"type": "string",
"example": "",
"required": false,
"description": "Who are the executors?"
},
"passport_number": {
"type": "string",
"example": "123456",
"required": false,
"description": "The passport number of the client"
},
"cigarettes_daily": {
"type": "integer",
"example": 6,
"required": false,
"description": "The amount of cigarettes the client smokes a day."
},
"date_of_forecast": {
"type": "date",
"example": "2025-06-26T11:37:02+01:00",
"required": false,
"description": "What is the date of the obtained forecast"
},
"date_of_marriage": {
"type": "date",
"example": "2025-06-26",
"required": false,
"description": "Date of marriage"
},
"has_iht_planning": {
"type": "boolean",
"example": true,
"required": false,
"description": "Whether the client has Inheritance Tax (IHT) planning or not."
},
"is_will_accurate": {
"type": "boolean",
"example": true,
"required": false,
"description": "Does your current will reflect your wishes?"
},
"next_review_date": {
"type": "date",
"example": "2025-07-26",
"required": false,
"description": "Date of next review"
},
"will_poa_details": {
"type": "string",
"example": "",
"required": false,
"description": "Who are the Attorney’s?"
},
"has_gifted_family": {
"type": "boolean",
"example": true,
"required": false,
"description": "Whether the client has gifted the family."
},
"client_preferences": {
"type": "string",
"example": "Prefers telephone calls in the morning.",
"required": false,
"description": "Any client preferences."
},
"first_contact_date": {
"type": "date",
"example": "2025-05-26",
"required": false,
"description": "The date of the first contact."
},
"iht_planning_notes": {
"type": "string",
"example": "Notes on the client's Inheritance Tax (IHT) planning.",
"required": false,
"description": "Notes on the client's Inheritance Tax (IHT) planning."
},
"introduced_by_uuid": {
"type": "string",
"example": "c9bb5bb1-c4ec-414b-9f67-2fd4dc64ba30",
"required": false,
"description": "The UUID of the introducer for this client"
},
"primary_email_uuid": {
"type": "string",
"example": "4e893b09-00c0-4572-99ed-8c32d85df60c",
"required": false,
"description": "uuid of the primary email contact detail"
},
"residential_status": {
"type": "string",
"example": "settled",
"required": false,
"description": "Residential status"
},
"will_gifts_details": {
"type": "string",
"example": "",
"required": false,
"description": "Notes of gifts"
},
"will_last_reviewed": {
"type": "date",
"example": "2025-06-26",
"required": false,
"description": "The date of the last time the will's been reviewed."
},
"third_party_offered": {
"type": "boolean",
"example": true,
"required": false,
"description": "Whether the client has been offered any third party."
},
"checked_sanctions_at": {
"type": "date",
"example": "2025-06-26",
"required": false,
"description": "Date the client was checked for sanctions"
},
"country_of_residence": {
"type": "string",
"example": "United Kingdom",
"required": false,
"description": "Country of residence"
},
"long_term_care_notes": {
"type": "string",
"example": "Notes on the client's long term care.",
"required": false,
"description": "Notes on the client's long term care."
},
"previous_review_date": {
"type": "date",
"example": "2025-05-26",
"required": false,
"description": "Date of previous review"
},
"primary_address_uuid": {
"type": "string",
"example": "0b2c9012-6e43-4244-ae1b-bae2408377c5",
"required": false,
"description": "uuid of the primary address"
},
"procedure_adaptation": {
"type": "boolean",
"example": false,
"required": false,
"description": "Whether any procedures need to be adapted to the client."
},
"state_retirement_age": {
"type": "integer",
"example": 60,
"required": false,
"description": "The state retirement age."
},
"will_bequests_detail": {
"type": "string",
"example": "",
"required": false,
"description": "Details of any Bequests"
},
"assigned_adviser_uuid": {
"type": "string",
"example": "e6579c47-dc23-471e-980d-1b24aeae692d",
"required": false,
"description": "The UUID of the employee that the client directly reports to"
},
"has_power_of_attorney": {
"type": "boolean",
"example": true,
"required": false,
"description": "Whether the client has power of attorney."
},
"is_married_to_partner": {
"type": "boolean",
"example": true,
"required": false,
"description": "Denotes if the client is married to their partner"
},
"long_term_care_needed": {
"type": "boolean",
"example": false,
"required": false,
"description": "Whether the client required long term care."
},
"prospect_converted_at": {
"type": "date",
"example": "2025-06-26T11:37:02+01:00",
"required": false,
"description": "The datetime when the prospect was converted into a client."
},
"target_retirement_age": {
"type": "integer",
"example": 60,
"required": false,
"description": "Targest retirement age."
},
"vulnerability_details": {
"type": "string",
"example": "No vulnerabilities",
"required": false,
"description": "Any details regarding the client's vulnerabilities."
},
"adaption_details_notes": {
"type": "boolean",
"example": "Adaptation notes",
"required": false,
"description": "Any notes regarding adaptations"
},
"do_not_contact_via_fax": {
"type": "boolean",
"example": false,
"required": false,
"description": "Denotes if the client can be contacted via fax"
},
"do_not_contact_via_sms": {
"type": "boolean",
"example": false,
"required": false,
"description": "Denotes if the client can be contacted via SMS"
},
"anniversary_review_date": {
"type": "date",
"example": "2025-06-26",
"required": false,
"description": "Anniversary review date"
},
"current_life_stage_uuid": {
"type": "string",
"example": "3fc478e5-4347-4d2a-985d-b7998dfbf148",
"required": false,
"description": "The clients current life stage for expenditure."
},
"current_state_of_health": {
"type": "string",
"example": "Fit and healthy",
"required": false,
"description": "The client's current state of health."
},
"do_not_contact_via_mail": {
"type": "boolean",
"example": false,
"required": false,
"description": "Denotes if the client can be contacted via mail"
},
"expected_retirement_age": {
"type": "integer",
"example": 60,
"required": false,
"description": "The expected retirement age."
},
"has_obtained_a_forecast": {
"type": "boolean",
"example": true,
"required": false,
"description": "Have you recently obtained a forecast"
},
"power_of_attorney_notes": {
"type": "string",
"example": "Notes on the client's power of attorney.",
"required": false,
"description": "Notes on the client's power of attorney."
},
"projected_state_pension": {
"type": "integer",
"example": 50000,
"required": false,
"description": "What is the projected State Pension"
},
"units_of_alcohol_weekly": {
"type": "integer",
"example": 28,
"required": false,
"description": "The units of alcohol digested weekly."
},
"do_not_contact_via_email": {
"type": "boolean",
"example": false,
"required": false,
"description": "Denotes if the client can be contacted via email"
},
"assigned_paraplanner_uuid": {
"type": "string",
"example": "210e92d0-9799-4f7c-973f-afbbad56ce6e",
"required": false,
"description": "The UUID of the paraplanner employee that the client has been assigned"
},
"poa_attorney_appointed_at": {
"type": "date",
"example": "2025-06-26T00:00:00+01:00",
"required": false,
"description": "When were the Attorney’s appointed?"
},
"primary_phone_number_uuid": {
"type": "string",
"example": "590b8fc4-2dd9-4f1e-9dcd-ed3d4bb96319",
"required": false,
"description": "uuid of the primary phone number contact detail"
},
"assigned_administrator_uuid": {
"type": "string",
"example": "c57f2f18-bb5e-4fef-bce5-83a00ba060b4",
"required": false,
"description": "The UUID of the adviser employee that the client has been assigned"
},
"is_anticipating_inheritance": {
"type": "boolean",
"example": true,
"required": false,
"description": "Whether the client is anticipating/ expecting any inheritance."
},
"state_of_health_explanation": {
"type": "string",
"example": "Explanation of the current state of health.",
"required": false,
"description": "Explanation of the current state of health."
},
"are_poa_documents_registered": {
"type": "boolean",
"example": true,
"required": false,
"description": "Are the documents registered?"
},
"do_not_contact_via_telephone": {
"type": "boolean",
"example": false,
"required": false,
"description": "Denotes if the client can be contacted via telephone"
},
"is_poa_registered_epa_or_lpa": {
"type": "string",
"example": "epa",
"required": false,
"description": "Is the Power of Attorney Registered as a EPA or LPA"
},
"anticipating_inheritance_notes": {
"type": "string",
"example": "Notes on the client's inheritance anticipation/ expectations.",
"required": false,
"description": "Notes on the client's inheritance anticipation/ expectations."
},
"last_used_nicotine_products_date": {
"type": "date",
"example": "2024-06-26",
"required": false,
"description": "The date of the last time the client used nicotine products."
},
"is_in_receipt_of_your_state_pension": {
"type": "boolean",
"example": true,
"required": false,
"description": "Are you in receipt of your State Pension"
},
"are_poa_appointed_for_health_or_wealth": {
"type": "string",
"example": "health",
"required": false,
"description": "Are the Attorneys appointed for Health, Wealth or Both?"
},
"years_of_national_insurance_contributions": {
"type": "integer",
"example": 5,
"required": false,
"description": "How many years have you made Nation Insurance Contributions"
}
}
],
"Employee": [
{
"role": {
"type": "string",
"example": "owner",
"required": false,
"description": "The role of the employee."
},
"email": {
"type": "string",
"example": "gareth.thompson@plannrcrm.com",
"required": false,
"description": "The email of the employee. Required when with_login is present."
},
"groups": {
"type": "array",
"example": [
"3214f0b7-c82c-44ca-a14f-77133f281157",
"c548eb83-fb64-472b-b7ec-7672cc3fd4cc"
],
"required": false,
"description": "Group UUIDs to sync employee to. Null can be provided to clear an employees groups"
},
"last_name": {
"type": "string",
"example": "Thompson",
"required": false,
"description": "The last name of the employee."
},
"first_name": {
"type": "string",
"example": "Gareth",
"required": false,
"description": "The first name of the employee."
},
"advice_type": {
"type": "string",
"example": "independent",
"required": false,
"description": "Employee's RMAR advice type"
},
"departments": {
"type": "array",
"example": [
"paraplanner",
"adviser"
],
"required": false,
"description": "The departments the employee is part of"
},
"inactive_at": {
"type": "date",
"example": "2025-06-26",
"required": false,
"description": "Inactive from date"
},
"adviser_split_uuid": {
"type": "string",
"example": "10ff3fd7-b84f-4d4b-a0f3-e43ed3d8a276",
"required": false,
"description": "Adviser split"
},
"meeting_booking_url": {
"type": "string",
"example": "https://calendly.com/gareth-codepotato",
"required": false,
"description": "Employee's meeting booking URL"
},
"assigned_adviser_uuid": {
"type": "string",
"example": "d8cdd850-fee8-4f02-9cd5-1b606f5b2046",
"required": false,
"description": "The uuid of the senior employee that the employee directly reports to"
}
}
],
"Introducer": [
{
"title": {
"type": "string",
"example": "Mr",
"required": false,
"description": "Title"
},
"groups": {
"type": "array",
"example": [
"e3675bf5-3c09-4460-b2cd-03ab9aebdaf0",
"1672b5fa-bff9-429d-9dd6-73b6397d0af4"
],
"required": false,
"description": "Group UUIDs to sync introducer to. Null can be provided to clear an introducers groups"
},
"last_name": {
"type": "string",
"example": "Stanton",
"required": false,
"description": "Last name"
},
"first_name": {
"type": "string",
"example": "Patrick",
"required": false,
"description": "First name"
},
"entity_name": {
"type": "string",
"example": "PatrickCo",
"required": false,
"description": "Entity/business name"
},
"inactive_at": {
"type": "date",
"example": "2025-06-26",
"required": false,
"description": "Inactive from date"
},
"assigned_adviser_uuid": {
"type": "string",
"example": "a681f2c7-5028-4a19-b8a9-257f1d0cad56",
"required": false,
"description": "UUID of the account that this account reports to"
},
"charge_split_schema_uuid": {
"type": "string",
"example": "37efc11c-a400-4c40-9a44-ce37059d3244",
"required": false,
"description": "Charge split schema that is always used when adding a charge split for this introducer"
}
}
]
}
Response examples (200)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "6a8275c2-e97f-49a8-a603-d4e3525d2547",
"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": "2025-06-26T11:37:02+01:00",
"updated_at": "2025-06-26T11:37:02+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",
"portal_background": "#f6f6f6",
"portal_brand_title": "#323b4b",
"sidebar_background": "#0E0E56",
"portal_sidebar_icon": "#828994",
"portal_sidebar_text": "#323b4b",
"portal_account_email": "#828994",
"portal_sidebar_title": "#11151d",
"sidebar_title_primary": "#FFC634",
"portal_brand_sub_title": "#828994",
"portal_sidebar_divider": "#e3e5e9",
"email_button_background": "#36367E",
"portal_dashboard_bg_one": "#EF4583",
"portal_dashboard_bg_two": "#FFC634",
"sidebar_title_secondary": "#ffffff",
"sidebar_title_background": "#36367E",
"portal_sidebar_icon_hover": "#828994",
"portal_sidebar_text_hover": "#323b4b",
"portal_sidebar_icon_active": "#828994",
"portal_sidebar_text_active": "#323b4b",
"email_logo_background_panel": "#36367E",
"portal_sidebar_button_hover": "#ffffff",
"portal_sidebar_account_title": "#11151d",
"portal_sidebar_button_active": "#ffffff",
"sidebar_title_secondary_hover": "#ffffff",
"portal_sidebar_button_background": "#f6f6f6"
},
"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!",
"show_fact_find_illustrations": true
},
"name": "Gareth Thompson",
"role": "client",
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "f3de5940-f48f-4690-8ca0-9013f35f84dc",
"colour": "#ef4582",
"created_at": "2025-06-26T11:37:02+01:00",
"updated_at": "2025-06-26T11:37:02+01:00"
}
],
"type": "client",
"uuid": "e10bcb2b-d9df-49bc-a28b-576afdc14194",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "d5d5de68-e633-46fc-b0f1-700829f4666e",
"created_at": "2025-06-26T11:37:02+01:00",
"updated_at": "2025-06-26T11:37:02+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "240d4248-f731-4f98-9b99-387d6401970e",
"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": "948e8c46-0c27-4aba-a75d-1e566cb3d786",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-26T11:37:02+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-26T11:37:02+01:00",
"with_login": true,
"inactive_at": "2025-06-26",
"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": "2025-06-26T11:37:02+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-26T11:37:02+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-06-26T11:37:02+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-26T11:37:02+01:00"
}
],
"last_name": "Thompson",
"created_at": "2025-06-26T11:37:02+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-26T11:37:02+01:00",
"with_login": true,
"inactive_at": "2025-06-26",
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "67ace58b-ffa2-4817-9097-dfe030bb730d",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-06-26T11:37:02+01:00",
"updated_at": "2025-06-26T11:37:02+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": "ac2271c0-54cd-4c1e-ab11-f58ca87abc89",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-26T11:37:02+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-26T11:37:02+01:00",
"with_login": true,
"inactive_at": "2025-06-26",
"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": "2025-06-26T11:37:02+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-26T11:37:02+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-06-26T11:37:02+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-26T11:37:02+01:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "e4f18b8c-4644-4908-bd74-e15929cbb45c",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-06-26T11:37:02+01:00",
"updated_at": "2025-06-26T11:37:02+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": "800680f2-abe4-460e-aaaf-b0c35293e6ad",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-26T11:37:02+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-26T11:37:02+01:00",
"with_login": true,
"inactive_at": "2025-06-26",
"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": "2025-06-26T11:37:02+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-26T11:37:02+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-06-26T11:37:02+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-26T11:37:02+01:00"
},
"next_review_date": "2025-06-26T11:37:02+01:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "559e17f9-b5d6-44a6-9d05-6584254105c7",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2025-06-26T11:15:02+01:00",
"is_active": true,
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-06-26T11:37:02+01:00",
"start_date": "2025-06-26T10:47:02+01:00",
"updated_at": "2025-06-26T11:37:02+01:00",
"description": "This is a description.",
"trackable_type": "Client",
"total_time_in_minutes": 28,
"computed_time_elapsed_in_seconds": 1680
},
"first_contact_date": "2025-06-26T11:37:02+01:00",
"external_references": [
{
"uuid": "1031f9fd-05e3-48cb-bbad-fb33e7ff9970",
"reference": "AB123456",
"created_at": "2025-06-26T11:37:02+01:00",
"updated_at": "2025-06-26T11:37:02+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": "cf548fcf-5d5b-4d41-810a-4f45cdfae48b",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-26T11:37:02+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-26T11:37:02+01:00",
"with_login": true,
"inactive_at": "2025-06-26",
"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": "2025-06-26T11:37:02+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-26T11:37:02+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-06-26T11:37:02+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-26T11:37:02+01:00"
},
"joint_account_circle": {
"name": "Jones Family",
"uuid": "98d78446-dc3f-4ded-8522-e45fb5e6f19f",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-06-26T11:37:02+01:00",
"updated_at": "2025-06-26T11:37:02+01:00",
"joint_account_uuid": "55108c94-7e6e-460c-b168-41759c9e3e23"
},
"ownership_percentage": 100,
"previous_review_date": "2025-06-26T11:37:02+01:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "4b79e356-854b-4fb5-9a94-b26aa0deccaf",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-06-26T11:37:02+01:00",
"updated_at": "2025-06-26T11:37:02+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": "2d368d81-adac-4781-b60c-4d6ca41f2b83",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-26T11:37:02+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-26T11:37:02+01:00",
"with_login": true,
"inactive_at": "2025-06-26",
"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": "2025-06-26T11:37:02+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-26T11:37:02+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-06-26T11:37:02+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-26T11:37:02+01:00"
},
"anniversary_review_date": "2025-06-26T11:37:02+01:00"
}