Body
-
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":["1a81b7b3-1112-470c-ae70-9547e6599226","7277cfb3-2534-468a-9fe9-c3b7415fe055","330ef047-66c2-43b4-bdca-818aafee1aa8"],"assigned_to_uuids":["96065def-41d0-4107-98bb-eee25a25f298","1c9d0362-a458-4c04-bb63-5227e2302233","42a2352e-7bc5-4773-af8d-99b9a272fc9b"],"group_uuids":["e860516f-01fc-4a7b-9e17-7f0bc5567fcf","86bea5a0-5a93-422c-a0e4-4cd3cfaabea6","be5ce215-33f8-49b0-87ea-a54759554fbb"],"status":"cba538ed-e149-4617-9ffa-efa16b5c0b64","review_at":"2026-02-26T15:22:27+00:00","type":"8aad88b7-a380-4617-8222-cd7a3d9b305a","value":15099,"plans":["902f1027-d32f-4a56-8656-8531c99d35fa","6c091838-e0ac-4908-913c-7315e1f532d1","eeda0965-69d1-4508-b17f-3a3b3f3a5d95"]}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "Patrick's Case",
"participants": [
"1a81b7b3-1112-470c-ae70-9547e6599226",
"7277cfb3-2534-468a-9fe9-c3b7415fe055",
"330ef047-66c2-43b4-bdca-818aafee1aa8"
],
"assigned_to_uuids": [
"96065def-41d0-4107-98bb-eee25a25f298",
"1c9d0362-a458-4c04-bb63-5227e2302233",
"42a2352e-7bc5-4773-af8d-99b9a272fc9b"
],
"group_uuids": [
"e860516f-01fc-4a7b-9e17-7f0bc5567fcf",
"86bea5a0-5a93-422c-a0e4-4cd3cfaabea6",
"be5ce215-33f8-49b0-87ea-a54759554fbb"
],
"status": "cba538ed-e149-4617-9ffa-efa16b5c0b64",
"review_at": "2026-02-26T15:22:27+00:00",
"type": "8aad88b7-a380-4617-8222-cd7a3d9b305a",
"value": 15099,
"plans": [
"902f1027-d32f-4a56-8656-8531c99d35fa",
"6c091838-e0ac-4908-913c-7315e1f532d1",
"eeda0965-69d1-4508-b17f-3a3b3f3a5d95"
]
}
Response examples (200)
{
"name": "finance",
"slug": "finance",
"type": {
"name": "Mortgage Plan",
"uuid": "be33cb0b-b813-4ef8-8fd6-ad5c034679c1",
"created_at": "2026-02-26T15:22:27+00:00",
"updated_at": "2026-02-26T15:22:27+00:00"
},
"uuid": "ef753fae-1320-44ce-88b8-725579beb38d",
"plans": {
"name": "Johns ISA",
"tags": "App\\Http\\Resources\\TagResource",
"type": "cash_account",
"uuid": "9048d2e9-39e0-49b7-976a-e1e16ce4cec6",
"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": "2026-02-26T15:22:27+00:00",
"valued_at": "2026-02-26T15:22:27+00:00",
"created_at": "2026-02-26T15:22:27+00:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2026-02-26T15:22:27+00:00",
"advice_area": "non_investment_insurance",
"inactive_at": "2026-02-26T15:22:27+00:00",
"review_date": "2025-02-26",
"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": "2026-02-25T15:22:27+00:00",
"proposal_reference": "AB123456",
"visible_to_circles": "App\\Http\\Resources\\CircleResource",
"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"
}
},
"linked_policy_numbers": "App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource",
"is_group_scheme_member": false,
"originally_sold_by_firm": true,
"agency_in_your_name_from": "2025-02-26",
"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": "4b01cd7b-d52e-4f15-b155-8b442fd54350",
"colour": "#23852B",
"position": 5,
"created_at": "2026-02-26T15:22:27+00:00",
"updated_at": "2026-02-26T15:22:27+00:00",
"is_type_completed": false
},
"review_at": "2026-02-26T15:22:27+00:00",
"created_at": "2026-02-26T15:22:27+00:00",
"updated_at": "2026-02-26T15:22:27+00:00",
"group_uuids": [
"f875dacb-522b-4a57-94f3-f925d8a103f1"
],
"completed_at": "2026-02-26T15:22:27+00:00",
"participants": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "3428da38-7578-41b2-8c24-5ee71c7b4b35",
"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": "2026-02-26T15:22:27+00:00",
"first_name": "Gareth",
"updated_at": "2026-02-26T15:22:27+00:00",
"with_login": true,
"inactive_at": "2026-02-26",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"referral_code": "ABC12345",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2026-02-26T15:22:27+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2026-02-26T15:22:27+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"last_interaction_at": "2026-02-26 15:22:27",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2026-02-26T15:22:27+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2026-02-26T15:22:27+00:00"
},
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "dc32a97d-1f2e-419e-8a4a-2fb2fdf39789",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2026-02-26T15:22:27+00:00",
"updated_at": "2026-02-26T15:22:27+00:00",
"is_required": false,
"selection_options": [
"Coffee",
"Tea",
"Water"
]
}
],
"status_position": 4,
"task_board_uuid": "ee86fb76-af95-45c3-94c8-dd3e6c3b45da",
"assigned_to_uuids": [
"46281c79-c54a-48b8-a593-7972cf6803fb"
],
"participants_count": 4
}