Body
-
Name of the case
-
The uuid of the status chosen for the case
-
The case status's new position on the status list. Starting from 1. Only used if you are formatting cases in a kanban layout.
-
Array of account UUIDs
-
UUIDs of groups that will be assigned when the case is created.
-
Timestamp of when the case will be reviewed
-
The uuid of the type chosen for the case
-
Expect value the case will generate in pennies
-
Timestamp of when the case was completed
-
The uuids of the plans that will be associated to the case when it is created. Leave NULL to disassociate all plans from the case.
-
Custom field values keyed by the custom field reference. Only references configured for cases (and matching the case's type/status, where conditional) are accepted.
Additional properties are allowed.
curl \
--request PUT 'https://api.plannrcrm.com/api/v1/cases/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{
"name": "Annual review",
"status": "49a5ca00-09a7-41b7-a9e2-0219cdb544b0",
"status_position": 4,
"assigned_to_uuids": [
"a4b24800-da5c-40b5-9764-7bd0e8c4a38b",
"bbe7b907-5c97-410d-8e84-08909cc1e41a",
"6d71848a-1876-4ee0-bedc-1983ffa58810"
],
"group_uuids": [
"9b3698a6-3a57-4534-8e4d-d16d5246c494",
"a74e0354-2fc0-4d5e-bad6-9194f2c6f46f",
"147ef1eb-293c-468f-836c-301ca3ecbbce"
],
"review_at": "2026-11-19T12:59:39+00:00",
"type": "fbf72baf-1e76-41cf-bfc5-7f28faa91caa",
"value": 15099,
"completed_at": "2026-11-19T12:59:39+00:00",
"plans": [
"a699b0c2-979e-4ea0-9271-ff399e511807",
"6463c05f-a558-42d2-8bb9-420cebbcf49f",
"6364962e-9437-44c8-846c-51c86a889570"
],
"custom_fields": {
"ongoing_case": "Not Ongoing"
}
}'
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "Annual review",
"status": "49a5ca00-09a7-41b7-a9e2-0219cdb544b0",
"status_position": 4,
"assigned_to_uuids": [
"a4b24800-da5c-40b5-9764-7bd0e8c4a38b",
"bbe7b907-5c97-410d-8e84-08909cc1e41a",
"6d71848a-1876-4ee0-bedc-1983ffa58810"
],
"group_uuids": [
"9b3698a6-3a57-4534-8e4d-d16d5246c494",
"a74e0354-2fc0-4d5e-bad6-9194f2c6f46f",
"147ef1eb-293c-468f-836c-301ca3ecbbce"
],
"review_at": "2026-11-19T12:59:39+00:00",
"type": "fbf72baf-1e76-41cf-bfc5-7f28faa91caa",
"value": 15099,
"completed_at": "2026-11-19T12:59:39+00:00",
"plans": [
"a699b0c2-979e-4ea0-9271-ff399e511807",
"6463c05f-a558-42d2-8bb9-420cebbcf49f",
"6364962e-9437-44c8-846c-51c86a889570"
],
"custom_fields": {
"ongoing_case": "Not Ongoing"
}
}
{
"uuid": "ad8cc1d4-5ffc-431d-b62b-8035fea27ab7",
"created_at": "2026-11-19T12:59:39+00:00",
"updated_at": "2026-11-19T12:59:39+00:00",
"name": "finance",
"slug": "finance",
"status": {
"uuid": "01d91df4-89c2-4149-8a7c-85bb8fd111e6",
"created_at": "2026-11-19T12:59:39+00:00",
"updated_at": "2026-11-19T12:59:39+00:00",
"name": "To Be Reviewed",
"colour": "#23852B",
"position": 5,
"is_type_completed": false
},
"type": {
"uuid": "b01b1344-eba7-4bff-8826-3c353e1bc12f",
"name": "Mortgage Plan",
"created_at": "2026-11-19T12:59:39+00:00",
"updated_at": "2026-11-19T12:59:39+00:00"
},
"review_at": "2026-11-19T12:59:39+00:00",
"assigned_to_uuids": [
"4937f7aa-05c7-4168-b301-df8d642d430a"
],
"group_uuids": [
"d2a85835-e9be-44de-8a98-bab52e902591"
],
"completed_at": "2026-11-19T12:59:39+00:00",
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"status_position": 4,
"participants_count": 4,
"participants": {
"uuid": "b5828b1d-7c52-4b41-9bb4-f31a70f0cca2",
"created_at": "2026-11-19T12:59:39+00:00",
"updated_at": "2026-11-19T12:59:39+00: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",
"firm": {
"uuid": "c05c457c-44e7-42c1-ad1a-4ed000be02d1",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"name": "Codepotato",
"slug": "codepotato",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"town_city": "Waterlooville",
"county": "Hampshire",
"postcode": "PO7 7YH",
"country": "United Kingdom",
"regulatory_text": "Regulatory text",
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
"brand_colours": {
"sidebar_background": "#0E0E56",
"sidebar_accent": "#36367E",
"sidebar_text": "#FFFFFF",
"sidebar_hover": "#0A0A42",
"sidebar_active": "#53DBB8",
"sidebar_title_background": "#36367E",
"sidebar_title_primary": "#FFC634",
"sidebar_title_secondary": "#FFFFFF",
"sidebar_title_secondary_hover": "#FFFFFF",
"email_background": "#0E0E56",
"email_logo_background_panel": "#36367E",
"email_sub_text": "#FFFFFF",
"email_button_background": "#36367E",
"email_button_text": "#FFFFFF",
"portal_sidebar_button_background": "#F6F6F6",
"portal_sidebar_button_hover": "#FFFFFF",
"portal_sidebar_button_active": "#FFFFFF",
"portal_brand_title": "#323B4B",
"portal_brand_sub_title": "#828994",
"portal_sidebar_title": "#11151D",
"portal_sidebar_text": "#323B4B",
"portal_sidebar_text_hover": "#323B4B",
"portal_sidebar_text_active": "#323B4B",
"portal_sidebar_icon": "#828994",
"portal_sidebar_icon_hover": "#828994",
"portal_sidebar_icon_active": "#828994",
"portal_background": "#F6F6F6",
"portal_sidebar_account_title": "#11151D",
"portal_sidebar_account_email": "#828994",
"portal_sidebar_divider": "#E3E5E9",
"portal_dashboard_bg_one": "#EF4583",
"portal_dashboard_bg_two": "#FFC634",
"portal_sidebar_collapse_button": "#828994",
"portal_sidebar_collapse_button_hover": "#B3B9C4",
"portal_sidebar_user_select_background": "#F6F6F6",
"portal_sidebar_user_select_hover": "#F6F6F6",
"portal_sidebar_user_select_text": "#323B4B",
"portal_sidebar_user_select_text_hover": "#323B4B",
"portal_sidebar_user_select_border": "#EEEEEE",
"portal_sidebar_user_select_border_hover": "#828994"
},
"factfind_pdf_header_background": "#0E0E56",
"factfind_pdf_header_text": "#ffffff",
"factfind_pdf_logo": "https://api.plannrcrm.com/images/plannr.jpg",
"is_subscribed": true,
"keep_deleted_files_for": 30,
"tax": 17.5,
"month_end": 25,
"statement_frequency": "monthly",
"billing": {
"invoice_address_1": "Suite E, 5 The Briars",
"invoice_address_2": "Waterberry Drive",
"invoice_town_city": "Waterlooville",
"invoice_county": "Hampshire",
"invoice_postcode": "PO7 7YH",
"invoice_country": "United Kingdom",
"invoice_email": "gareth@codepotato.co.uk"
},
"ip_whitelist": [
"192.168.0.1",
"127.0.0.1"
],
"welcome_paragraph_html": "<h1>Welcome.</h1>",
"email_welcome_paragraph_html": "Welcome to Plannr!",
"show_fact_find_illustrations": true,
"cc_email_addresses": [
"jack@example.com",
"jill@example.com"
],
"bcc_email_addresses": [
"jack@example.com",
"jill@example.com"
],
"reply_to_email_address": "jack@example.com",
"mobile_app_support_number": "01234 567890",
"mobile_app_support_email": "support@example.com"
},
"primary_phone_number": {
"uuid": "2c9be8e5-1ec7-4d53-8534-5a4df5891e20",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"type": "phone_number",
"name": "Work number",
"value": "+443330903630",
"phone_number_meta": {
"country": "GB",
"formatted": "0333 090 3630"
}
},
"primary_email": {
"uuid": "2c9be8e5-1ec7-4d53-8534-5a4df5891e20",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"type": "phone_number",
"name": "Work number",
"value": "+443330903630",
"phone_number_meta": {
"country": "GB",
"formatted": "0333 090 3630"
}
},
"current_time_entry": {
"uuid": "d2e12d94-ec93-41bf-8880-ef76744c774f",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"name": "Research",
"description": "This is a description.",
"trackable_type": "Client",
"start_date": "2026-11-19T12:09:45+00:00",
"end_date": "2026-11-19T12:37:45+00:00",
"is_active": true,
"total_time_in_minutes": 28,
"computed_time_elapsed_in_seconds": 1680
},
"assigned_adviser": {
"uuid": "8d07cd91-bd4d-4bd1-bbde-b18d67214e1b",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00: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",
"first_contact_date": "2026-11-19T12:59:45+00:00",
"next_review_date": "2026-11-19T12:59:45+00:00",
"previous_review_date": "2026-11-19T12:59:45+00:00",
"anniversary_review_date": "2026-11-19T12:59:45+00:00",
"terms_of_business_at": "2026-11-19T12:59:45+00:00",
"client_agreement_at": "2026-11-19T12:59:45+00:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-11-19",
"last_interaction_at": "2026-11-19 12:59:45",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-11-19T12:59:45+00:00",
"out_of_office_until": "2026-11-19T12:59:45+00:00",
"out_of_office_message": "I am away this week. For urgent matters please contact the office.",
"is_pending_fact_find_account": false,
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"managed_by_head_office": false
},
"assigned_administrator": {
"uuid": "8d07cd91-bd4d-4bd1-bbde-b18d67214e1b",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00: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",
"first_contact_date": "2026-11-19T12:59:45+00:00",
"next_review_date": "2026-11-19T12:59:45+00:00",
"previous_review_date": "2026-11-19T12:59:45+00:00",
"anniversary_review_date": "2026-11-19T12:59:45+00:00",
"terms_of_business_at": "2026-11-19T12:59:45+00:00",
"client_agreement_at": "2026-11-19T12:59:45+00:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-11-19",
"last_interaction_at": "2026-11-19 12:59:45",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-11-19T12:59:45+00:00",
"out_of_office_until": "2026-11-19T12:59:45+00:00",
"out_of_office_message": "I am away this week. For urgent matters please contact the office.",
"is_pending_fact_find_account": false,
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"managed_by_head_office": false
},
"assigned_paraplanner": {
"uuid": "8d07cd91-bd4d-4bd1-bbde-b18d67214e1b",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00: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",
"first_contact_date": "2026-11-19T12:59:45+00:00",
"next_review_date": "2026-11-19T12:59:45+00:00",
"previous_review_date": "2026-11-19T12:59:45+00:00",
"anniversary_review_date": "2026-11-19T12:59:45+00:00",
"terms_of_business_at": "2026-11-19T12:59:45+00:00",
"client_agreement_at": "2026-11-19T12:59:45+00:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-11-19",
"last_interaction_at": "2026-11-19 12:59:45",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-11-19T12:59:45+00:00",
"out_of_office_until": "2026-11-19T12:59:45+00:00",
"out_of_office_message": "I am away this week. For urgent matters please contact the office.",
"is_pending_fact_find_account": false,
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"managed_by_head_office": false
},
"introduced_by": {
"uuid": "8d07cd91-bd4d-4bd1-bbde-b18d67214e1b",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00: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",
"first_contact_date": "2026-11-19T12:59:45+00:00",
"next_review_date": "2026-11-19T12:59:45+00:00",
"previous_review_date": "2026-11-19T12:59:45+00:00",
"anniversary_review_date": "2026-11-19T12:59:45+00:00",
"terms_of_business_at": "2026-11-19T12:59:45+00:00",
"client_agreement_at": "2026-11-19T12:59:45+00:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-11-19",
"last_interaction_at": "2026-11-19 12:59:45",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-11-19T12:59:45+00:00",
"out_of_office_until": "2026-11-19T12:59:45+00:00",
"out_of_office_message": "I am away this week. For urgent matters please contact the office.",
"is_pending_fact_find_account": false,
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"managed_by_head_office": false
},
"business_unit": {
"uuid": "a2f8bd06-c20a-427d-be36-b8300a695601",
"name": "Wealth Management",
"has_alternative_branding": false,
"brand_colours": [],
"members_count": 3,
"groups_count": 2,
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00"
},
"groups": {
"uuid": null,
"name": "finance",
"slug": "finance",
"participants_count": "3",
"participants": {
"uuid": {
"example": null,
"description": "UUID of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"first_name": {
"example": "Gareth",
"description": "First name of the account"
},
"last_name": {
"example": "Thompson",
"description": "Last name of the account"
},
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"email": {
"example": "gareth@codepotato.co.uk",
"description": "Email of the account"
}
},
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00"
},
"tags": {
"uuid": "b6fd695a-d098-4624-81ab-a5b81faee37c",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"name": "Mortgage",
"slug": "mortgage",
"colour": "#ef4582"
},
"marketing_consent": {
"email": "opted_in",
"phone": "opted_out",
"letter": "not_captured",
"sms": "not_captured"
},
"owners": {
"uuid": "8d07cd91-bd4d-4bd1-bbde-b18d67214e1b",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00: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",
"first_contact_date": "2026-11-19T12:59:45+00:00",
"next_review_date": "2026-11-19T12:59:45+00:00",
"previous_review_date": "2026-11-19T12:59:45+00:00",
"anniversary_review_date": "2026-11-19T12:59:45+00:00",
"terms_of_business_at": "2026-11-19T12:59:45+00:00",
"client_agreement_at": "2026-11-19T12:59:45+00:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-11-19",
"last_interaction_at": "2026-11-19 12:59:45",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-11-19T12:59:45+00:00",
"out_of_office_until": "2026-11-19T12:59:45+00:00",
"out_of_office_message": "I am away this week. For urgent matters please contact the office.",
"is_pending_fact_find_account": false,
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"managed_by_head_office": false
},
"first_contact_date": "2026-11-19T12:59:39+00:00",
"next_review_date": "2026-11-19T12:59:39+00:00",
"previous_review_date": "2026-11-19T12:59:39+00:00",
"anniversary_review_date": "2026-11-19T12:59:39+00:00",
"terms_of_business_at": "2026-11-19T12:59:39+00:00",
"client_agreement_at": "2026-11-19T12:59:39+00:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": {
"uuid": "26b86c35-cd93-40ce-b49d-c5cdc5c2eab9",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"name": "Jones Family",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"bg_colour": "#35f4e1",
"has_portal_access": true,
"portal_access_status": "active",
"engagement_rating": "green",
"last_login": {
"logged_in_at": "2026-11-19T12:59:45+00:00",
"account_uuid": "uuid",
"account_name": "John Smith",
"device_type": "desktop",
"device_platform": "macos"
},
"portal_login_count_30d": 5,
"portal_login_count_90d": 12,
"portal_login_count_365d": 48,
"joint_account_uuid": "f3fc35c6-eddf-4941-85fc-59538175977c",
"login_access_level": "write",
"current_life_stage_uuid": "5ab02ee6-c206-43cf-8781-587b99f1d70c"
},
"circles": {
"uuid": "26b86c35-cd93-40ce-b49d-c5cdc5c2eab9",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"name": "Jones Family",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"bg_colour": "#35f4e1",
"has_portal_access": true,
"portal_access_status": "active",
"engagement_rating": "green",
"last_login": {
"logged_in_at": "2026-11-19T12:59:45+00:00",
"account_uuid": "uuid",
"account_name": "John Smith",
"device_type": "desktop",
"device_platform": "macos"
},
"portal_login_count_30d": 5,
"portal_login_count_90d": 12,
"portal_login_count_365d": 48,
"joint_account_uuid": "f3fc35c6-eddf-4941-85fc-59538175977c",
"login_access_level": "write",
"current_life_stage_uuid": "5ab02ee6-c206-43cf-8781-587b99f1d70c"
},
"ownership_percentage": 100,
"inactive_at": "2026-11-19",
"last_interaction_at": "2026-11-19 12:59:39",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-11-19T12:59:39+00:00",
"out_of_office_until": "2026-11-19T12:59:39+00:00",
"out_of_office_message": "I am away this week. For urgent matters please contact the office.",
"service_level": {
"uuid": "a1951cef-e2d8-4c6f-b054-d557b42b57fc",
"name": "Gold",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00"
},
"is_pending_fact_find_account": false,
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"managed_by_head_office": false,
"custom_fields": {
"uuid": null,
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"type": "string",
"name": "Favourite Drink",
"reference": "favourite_drink",
"is_required": false,
"value": "Coffee",
"selection_options": [
"Coffee",
"Tea",
"Water"
],
"help_text": "This is the client's favourite drink.",
"is_retired": false
},
"external_references": {
"uuid": "c9ff37a3-269e-4b25-b9df-3d0865c60180",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"third_party": "nucleus",
"reference": "AB123456"
}
},
"task_board_uuid": "c152eba4-7de6-451f-8547-f860c41461d7",
"plans": {
"uuid": "559cfdd0-2e60-4940-ae08-10da30b7848b",
"created_at": "2026-11-19T12:59:39+00:00",
"updated_at": "2026-11-19T12:59:39+00:00",
"opened_at": "2026-11-19T12:59:39+00:00",
"name": "Johns ISA",
"type": "cash_account",
"sub_type": "lifetime isa",
"abstract_type": "asset",
"policy_number": "AVIVA-123",
"proposal_reference": "AB123456",
"status": "inactive",
"inactive_at": "2026-11-19T12:59:39+00:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-11-19",
"originally_sold_by_firm": true,
"under_advice": true,
"visible_on_client_portal": true,
"include_in_client_valuation": true,
"show_on_joint": true,
"shown_on_circles": true,
"review_date": "2025-11-19",
"on_panel": true,
"is_group_scheme": false,
"is_sub_group_scheme": false,
"is_group_scheme_member": false,
"advice_area": "non_investment_insurance",
"main_account": {
"uuid": "88aac027-a012-46f4-8ba8-b78820cf3ead",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"name": "John's ISA",
"policy_number": "AVI-4837",
"is_main_account": false,
"statistics": {
"recent_growth": 100
}
},
"sub_accounts": {
"uuid": "88aac027-a012-46f4-8ba8-b78820cf3ead",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"name": "John's ISA",
"policy_number": "AVI-4837",
"is_main_account": false,
"statistics": {
"recent_growth": 100
}
},
"provider": {
"uuid": "4cf6eac0-0e35-47f8-afaf-c59c6685cb57",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"name": "AJ Bell",
"slug": "aj-bell"
},
"covers": {
"uuid": "2232a1e6-3771-4252-bdf7-42a5ef41f649",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"cover_type": "critical_illness",
"benefit_amount": {
"amount": {
"example": "25000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£250,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
},
"benefit_frequency": "monthly",
"benefit_status": "active",
"excess": {
"amount": {
"example": "10000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£100.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
},
"indexation": 1.4
},
"claims": {
"uuid": "d70542e3-5fce-4fff-8043-de4594d3760e",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"claim_amount": {
"amount": {
"example": "25000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£250,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
},
"claim_start_date": "2025-11-19",
"claim_end_date": "2031-11-19",
"claim_notes": "Claim notes"
},
"total_benefit_amount": {
"amount": {
"example": "25000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£250,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"total_benefits": {
"critical_illness": {
"amount": {
"example": "15000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£150,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"family_income_benefit": {
"amount": {
"example": "10000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£100,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
}
},
"latest_valuations": {
"uuid": "7b493d9a-b6a0-40a0-b914-d73f3b9a0602",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"valued_at": "2026-11-19T12:59:45+00:00",
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
}
},
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"valued_at": "2026-11-19T12:59:39+00:00",
"original_valued_at": "2026-11-18T12:59:39+00:00",
"client": {
"uuid": "8d07cd91-bd4d-4bd1-bbde-b18d67214e1b",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00: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",
"first_contact_date": "2026-11-19T12:59:45+00:00",
"next_review_date": "2026-11-19T12:59:45+00:00",
"previous_review_date": "2026-11-19T12:59:45+00:00",
"anniversary_review_date": "2026-11-19T12:59:45+00:00",
"terms_of_business_at": "2026-11-19T12:59:45+00:00",
"client_agreement_at": "2026-11-19T12:59:45+00:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-11-19",
"last_interaction_at": "2026-11-19 12:59:45",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-11-19T12:59:45+00:00",
"out_of_office_until": "2026-11-19T12:59:45+00:00",
"out_of_office_message": "I am away this week. For urgent matters please contact the office.",
"is_pending_fact_find_account": false,
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"managed_by_head_office": false
},
"accounts": {
"uuid": "8d07cd91-bd4d-4bd1-bbde-b18d67214e1b",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00: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",
"first_contact_date": "2026-11-19T12:59:45+00:00",
"next_review_date": "2026-11-19T12:59:45+00:00",
"previous_review_date": "2026-11-19T12:59:45+00:00",
"anniversary_review_date": "2026-11-19T12:59:45+00:00",
"terms_of_business_at": "2026-11-19T12:59:45+00:00",
"client_agreement_at": "2026-11-19T12:59:45+00:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-11-19",
"last_interaction_at": "2026-11-19 12:59:45",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-11-19T12:59:45+00:00",
"out_of_office_until": "2026-11-19T12:59:45+00:00",
"out_of_office_message": "I am away this week. For urgent matters please contact the office.",
"is_pending_fact_find_account": false,
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"managed_by_head_office": false
},
"seller": {
"uuid": "8d07cd91-bd4d-4bd1-bbde-b18d67214e1b",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00: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",
"first_contact_date": "2026-11-19T12:59:45+00:00",
"next_review_date": "2026-11-19T12:59:45+00:00",
"previous_review_date": "2026-11-19T12:59:45+00:00",
"anniversary_review_date": "2026-11-19T12:59:45+00:00",
"terms_of_business_at": "2026-11-19T12:59:45+00:00",
"client_agreement_at": "2026-11-19T12:59:45+00:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-11-19",
"last_interaction_at": "2026-11-19 12:59:45",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-11-19T12:59:45+00:00",
"out_of_office_until": "2026-11-19T12:59:45+00:00",
"out_of_office_message": "I am away this week. For urgent matters please contact the office.",
"is_pending_fact_find_account": false,
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"managed_by_head_office": false
},
"linked_owners": {
"uuid": "8d07cd91-bd4d-4bd1-bbde-b18d67214e1b",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00: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",
"first_contact_date": "2026-11-19T12:59:45+00:00",
"next_review_date": "2026-11-19T12:59:45+00:00",
"previous_review_date": "2026-11-19T12:59:45+00:00",
"anniversary_review_date": "2026-11-19T12:59:45+00:00",
"terms_of_business_at": "2026-11-19T12:59:45+00:00",
"client_agreement_at": "2026-11-19T12:59:45+00:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-11-19",
"last_interaction_at": "2026-11-19 12:59:45",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-11-19T12:59:45+00:00",
"out_of_office_until": "2026-11-19T12:59:45+00:00",
"out_of_office_message": "I am away this week. For urgent matters please contact the office.",
"is_pending_fact_find_account": false,
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"managed_by_head_office": false
},
"linked_plans": {
"uuid": "76b88a42-d458-4edb-9bb5-ab26e860feeb",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"opened_at": "2026-11-19T12:59:45+00:00",
"name": "Johns ISA",
"type": "cash_account",
"sub_type": "lifetime isa",
"abstract_type": "asset",
"policy_number": "AVIVA-123",
"proposal_reference": "AB123456",
"status": "inactive",
"inactive_at": "2026-11-19T12:59:45+00:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-11-19",
"originally_sold_by_firm": true,
"under_advice": true,
"visible_on_client_portal": true,
"include_in_client_valuation": true,
"show_on_joint": true,
"shown_on_circles": true,
"review_date": "2025-11-19",
"on_panel": true,
"is_group_scheme": false,
"is_sub_group_scheme": false,
"is_group_scheme_member": false,
"advice_area": "non_investment_insurance",
"total_benefit_amount": {
"amount": {
"example": "25000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£250,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
},
"total_benefits": {
"critical_illness": {
"amount": {
"example": "15000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£150,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
},
"family_income_benefit": {
"amount": {
"example": "10000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£100,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
}
},
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
},
"valued_at": "2026-11-19T12:59:45+00:00",
"original_valued_at": "2026-11-18T12:59:45+00:00",
"statistics": {
"recent_growth": 100
},
"is_wrap_product": false,
"is_wrap_child": false,
"can_be_deleted": "false"
},
"visible_to_circles": {
"uuid": "26b86c35-cd93-40ce-b49d-c5cdc5c2eab9",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"name": "Jones Family",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"bg_colour": "#35f4e1",
"has_portal_access": true,
"portal_access_status": "active",
"engagement_rating": "green",
"last_login": {
"logged_in_at": "2026-11-19T12:59:45+00:00",
"account_uuid": "uuid",
"account_name": "John Smith",
"device_type": "desktop",
"device_platform": "macos"
},
"portal_login_count_30d": 5,
"portal_login_count_90d": 12,
"portal_login_count_365d": 48,
"joint_account_uuid": "f3fc35c6-eddf-4941-85fc-59538175977c",
"login_access_level": "write",
"current_life_stage_uuid": "5ab02ee6-c206-43cf-8781-587b99f1d70c"
},
"statistics": {
"recent_growth": 100
},
"cases": {
"uuid": "466d68f8-3534-4446-a8c4-48486bbd6873",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"name": "finance",
"slug": "finance",
"review_at": "2026-11-19T12:59:45+00:00",
"assigned_to_uuids": [
null
],
"group_uuids": [
null
],
"completed_at": "2026-11-19T12:59:45+00:00",
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
},
"status_position": 4,
"participants_count": 4,
"task_board_uuid": null
},
"tags": {
"uuid": "b6fd695a-d098-4624-81ab-a5b81faee37c",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"name": "Mortgage",
"slug": "mortgage",
"colour": "#ef4582"
},
"is_wrap_product": false,
"is_wrap_child": false,
"wrap": {
"uuid": "76b88a42-d458-4edb-9bb5-ab26e860feeb",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"opened_at": "2026-11-19T12:59:45+00:00",
"name": "Johns ISA",
"type": "cash_account",
"sub_type": "lifetime isa",
"abstract_type": "asset",
"policy_number": "AVIVA-123",
"proposal_reference": "AB123456",
"status": "inactive",
"inactive_at": "2026-11-19T12:59:45+00:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-11-19",
"originally_sold_by_firm": true,
"under_advice": true,
"visible_on_client_portal": true,
"include_in_client_valuation": true,
"show_on_joint": true,
"shown_on_circles": true,
"review_date": "2025-11-19",
"on_panel": true,
"is_group_scheme": false,
"is_sub_group_scheme": false,
"is_group_scheme_member": false,
"advice_area": "non_investment_insurance",
"total_benefit_amount": {
"amount": {
"example": "25000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£250,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
},
"total_benefits": {
"critical_illness": {
"amount": {
"example": "15000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£150,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
},
"family_income_benefit": {
"amount": {
"example": "10000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£100,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
}
},
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
},
"valued_at": "2026-11-19T12:59:45+00:00",
"original_valued_at": "2026-11-18T12:59:45+00:00",
"statistics": {
"recent_growth": 100
},
"is_wrap_product": false,
"is_wrap_child": false,
"can_be_deleted": "false"
},
"wrap_children": {
"uuid": "76b88a42-d458-4edb-9bb5-ab26e860feeb",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"opened_at": "2026-11-19T12:59:45+00:00",
"name": "Johns ISA",
"type": "cash_account",
"sub_type": "lifetime isa",
"abstract_type": "asset",
"policy_number": "AVIVA-123",
"proposal_reference": "AB123456",
"status": "inactive",
"inactive_at": "2026-11-19T12:59:45+00:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-11-19",
"originally_sold_by_firm": true,
"under_advice": true,
"visible_on_client_portal": true,
"include_in_client_valuation": true,
"show_on_joint": true,
"shown_on_circles": true,
"review_date": "2025-11-19",
"on_panel": true,
"is_group_scheme": false,
"is_sub_group_scheme": false,
"is_group_scheme_member": false,
"advice_area": "non_investment_insurance",
"total_benefit_amount": {
"amount": {
"example": "25000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£250,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
},
"total_benefits": {
"critical_illness": {
"amount": {
"example": "15000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£150,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
},
"family_income_benefit": {
"amount": {
"example": "10000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£100,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
}
},
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
},
"valued_at": "2026-11-19T12:59:45+00:00",
"original_valued_at": "2026-11-18T12:59:45+00:00",
"statistics": {
"recent_growth": 100
},
"is_wrap_product": false,
"is_wrap_child": false,
"can_be_deleted": "false"
},
"linked_policy_numbers": {
"uuid": "f6ae44af-9a92-4b0d-b645-3396a90949f6",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"linked_policy_number": "ABC123-X"
},
"can_be_deleted": "false",
"contract_enquiry_account": {
"uuid": "8d07cd91-bd4d-4bd1-bbde-b18d67214e1b",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00: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",
"first_contact_date": "2026-11-19T12:59:45+00:00",
"next_review_date": "2026-11-19T12:59:45+00:00",
"previous_review_date": "2026-11-19T12:59:45+00:00",
"anniversary_review_date": "2026-11-19T12:59:45+00:00",
"terms_of_business_at": "2026-11-19T12:59:45+00:00",
"client_agreement_at": "2026-11-19T12:59:45+00:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-11-19",
"last_interaction_at": "2026-11-19 12:59:45",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-11-19T12:59:45+00:00",
"out_of_office_until": "2026-11-19T12:59:45+00:00",
"out_of_office_message": "I am away this week. For urgent matters please contact the office.",
"is_pending_fact_find_account": false,
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"managed_by_head_office": false
},
"mortgage_product": {
"uuid": "63cf4cbe-6687-4e5b-98f0-90a3a5d997b3",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"provider_reference": "example-reference",
"provider_scenario_name": "Single Applicant, Small Deposit",
"provider_scenario_data": [],
"lender_name": "HSBC",
"product_title": "5% Fixed Rate - 5 year"
},
"custom_fields": {
"uuid": null,
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"type": "string",
"name": "Favourite Drink",
"reference": "favourite_drink",
"is_required": false,
"value": "Coffee",
"selection_options": [
"Coffee",
"Tea",
"Water"
],
"help_text": "This is the client's favourite drink.",
"is_retired": false
},
"external_references": {
"uuid": "c9ff37a3-269e-4b25-b9df-3d0865c60180",
"created_at": "2026-11-19T12:59:45+00:00",
"updated_at": "2026-11-19T12:59:45+00:00",
"third_party": "nucleus",
"reference": "AB123456"
}
},
"custom_fields": [
{
"uuid": "e01783b4-d6c3-4468-8295-870055440259",
"created_at": "2026-11-19T12:59:39+00:00",
"updated_at": "2026-11-19T12:59:39+00:00",
"type": "string",
"name": "Favourite Drink",
"reference": "favourite_drink",
"is_required": false,
"value": "Coffee",
"selection_options": [
"Coffee",
"Tea",
"Water"
],
"help_text": "This is the client's favourite drink.",
"is_retired": false
}
]
}
{
"message": "The given data was invalid.",
"errors": {
"field": [
"The field is invalid."
]
}
}