Body
Required
-
The name of the case
-
Account uuids belonging to the firm. Must include at least one client.
-
Array of account UUIDs to assign to the case.
-
UUIDs of groups that will be assigned when the case is created.
-
The uuid of the status chosen for the case
-
The date the case should be reviewed
-
The uuid of the type chosen for the case
-
Expect value the case will generate in pennies
-
The uuids of the plans chosen for the case
POST
/api/v1/cases
curl \
--request POST 'https://api.plannrcrm.com/api/v1/cases' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"name":"Patrick's Case","participants":["95a8e1be-09dd-48c7-8381-86231e0a9230","3a0ebd9a-67ef-481c-909e-c733dfb58034"],"assigned_to_uuids":["bc63177d-9cb1-40f7-9d6c-8f143a06b0c7","57d47aa6-c063-48de-b331-7f18e920fd13"],"group_uuids":["c5e6ff5d-1882-4b33-a3f8-b4a374f1bbea","485dcf54-5dad-42a2-bf3b-09649f2957a6"],"status":"c3b92d7b-4803-41cd-884f-cef810625150","review_at":"2025-10-24T10:34:18+01:00","type":"328be5ad-c3ff-4bde-9f77-6518f8b8a83a","value":15099,"plans":["58fd86f3-c08a-4c68-b58e-4dfd2bfd84a7","e9a3ec26-ecb1-4906-9719-3a2cb878817c"]}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "Patrick's Case",
"participants": [
"95a8e1be-09dd-48c7-8381-86231e0a9230",
"3a0ebd9a-67ef-481c-909e-c733dfb58034"
],
"assigned_to_uuids": [
"bc63177d-9cb1-40f7-9d6c-8f143a06b0c7",
"57d47aa6-c063-48de-b331-7f18e920fd13"
],
"group_uuids": [
"c5e6ff5d-1882-4b33-a3f8-b4a374f1bbea",
"485dcf54-5dad-42a2-bf3b-09649f2957a6"
],
"status": "c3b92d7b-4803-41cd-884f-cef810625150",
"review_at": "2025-10-24T10:34:18+01:00",
"type": "328be5ad-c3ff-4bde-9f77-6518f8b8a83a",
"value": 15099,
"plans": [
"58fd86f3-c08a-4c68-b58e-4dfd2bfd84a7",
"e9a3ec26-ecb1-4906-9719-3a2cb878817c"
]
}
Response examples (200)
{
"name": "finance",
"slug": "finance",
"type": {
"name": "Mortgage Plan",
"uuid": "eddcbe71-60e0-40ad-a857-5217d6867e6c",
"created_at": "2025-10-24T10:34:18+01:00",
"updated_at": "2025-10-24T10:34:18+01:00"
},
"uuid": "a431cadd-b0c2-4d76-ac6a-3c309f739bdf",
"plans": {
"name": "Johns ISA",
"tags": "App\\Http\\Resources\\TagResource",
"type": "cash_account",
"uuid": "6dee783d-419c-4097-9d38-b6fbe602fc1d",
"wrap": "App\\Http\\Resources\\Plans\\PlanResource",
"cases": "App\\Http\\Resources\\CasesResource",
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
},
"claims": "App\\Http\\Resources\\Plans\\ClaimResource",
"client": "App\\Http\\Resources\\AccountResource",
"covers": "App\\Http\\Resources\\Plans\\CoverResource",
"seller": "App\\Http\\Resources\\AccountResource",
"status": "inactive",
"accounts": "App\\Http\\Resources\\AccountResource",
"on_panel": true,
"provider": "App\\Http\\Resources\\Plans\\ProviderResource",
"sub_type": "lifetime isa",
"opened_at": "2025-10-24T10:34:18+01:00",
"valued_at": "2025-10-24T10:34:18+01:00",
"created_at": "2025-10-24T10:34:18+01:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-10-24T10:34:18+01:00",
"advice_area": "non_investment_insurance",
"inactive_at": "2025-10-24T10:34:18+01:00",
"review_date": "2024-10-24",
"linked_plans": "App\\Http\\Resources\\Plans\\PlanResource",
"main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
"sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
"under_advice": true,
"abstract_type": "asset",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"is_wrap_child": false,
"linked_owners": "App\\Http\\Resources\\AccountResource",
"policy_number": "AVIVA-123",
"show_on_joint": true,
"wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
"can_be_deleted": "false",
"total_benefits": {
"critical_illness": {
"amount": {
"example": "15000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£150,000.00",
"description": "Money amount formatted with currency"
}
},
"family_income_benefit": {
"amount": {
"example": "10000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£100,000.00",
"description": "Money amount formatted with currency"
}
}
},
"inactive_reason": "claimed",
"is_group_scheme": false,
"is_wrap_product": false,
"shown_on_circles": true,
"latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
"original_valued_at": "2025-10-23T10:34:18+01:00",
"proposal_reference": "AB123456",
"agency_in_your_name": true,
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"is_sub_group_scheme": false,
"total_benefit_amount": {
"amount": {
"example": "25000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£250,000.00",
"description": "Money amount formatted with currency"
}
},
"is_group_scheme_member": false,
"originally_sold_by_firm": true,
"agency_in_your_name_from": "2024-10-24",
"contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
"visible_on_client_portal": true,
"include_in_client_valuation": true
},
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
},
"status": {
"name": "To Be Reviewed",
"uuid": "d7b81c48-d32e-4c86-80d9-4a7d404cbf31",
"colour": "#23852B",
"position": 5,
"created_at": "2025-10-24T10:34:18+01:00",
"updated_at": "2025-10-24T10:34:18+01:00",
"is_type_completed": false
},
"review_at": "2025-10-24T10:34:18+01:00",
"created_at": "2025-10-24T10:34:18+01:00",
"updated_at": "2025-10-24T10:34:18+01:00",
"group_uuids": [
"328bf32f-1e5a-413f-bf21-cc40c10cb167"
],
"completed_at": "2025-10-24T10:34:18+01:00",
"participants": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "5ddbbd82-de67-43cc-be8e-1398b8cd7487",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-10-24T10:34:18+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-24T10:34:18+01:00",
"with_login": true,
"inactive_at": "2025-10-24",
"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-10-24T10:34:18+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-24T10:34:18+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-10-24T10:34:18+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-24T10:34:18+01:00"
},
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "c66bb94a-2513-4691-8b53-a2b7b5dcad7a",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-10-24T10:34:18+01:00",
"updated_at": "2025-10-24T10:34:18+01:00",
"is_required": false,
"selection_options": [
"Coffee",
"Tea",
"Water"
]
}
],
"status_position": 4,
"task_board_uuid": "a810fc67-f7ff-4ed2-9671-e47626633994",
"assigned_to_uuids": [
"667c366f-871c-49bf-881e-9d8e42ee16c8"
],
"participants_count": 4
}