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":["cd3b0843-d8bf-41db-bf67-eae088706ad4","8b7e9db4-5c39-4ae8-9a27-95206287c93a"],"assigned_to_uuids":["f5af4e7f-5a8c-48a2-9890-a8add6ef1c17","060ebaaf-c469-494a-a000-68e80ab8cf00"],"group_uuids":["b8cd5d08-57a1-4a95-9421-c4a71f7e19b9","43c1d445-98f8-401a-9331-14f22d8572b1"],"status":"164df233-049a-463d-be42-0364be2d3912","review_at":"2025-08-27T17:31:26+01:00","type":"804399ae-0de5-46b1-af48-aeefa3a00f7f","value":15099,"plans":["cf056804-b471-4906-95b6-850a12a90360","9756c5c1-8264-4f0b-b2f6-00ab4fec1fa9"]}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "Patrick's Case",
"participants": [
"cd3b0843-d8bf-41db-bf67-eae088706ad4",
"8b7e9db4-5c39-4ae8-9a27-95206287c93a"
],
"assigned_to_uuids": [
"f5af4e7f-5a8c-48a2-9890-a8add6ef1c17",
"060ebaaf-c469-494a-a000-68e80ab8cf00"
],
"group_uuids": [
"b8cd5d08-57a1-4a95-9421-c4a71f7e19b9",
"43c1d445-98f8-401a-9331-14f22d8572b1"
],
"status": "164df233-049a-463d-be42-0364be2d3912",
"review_at": "2025-08-27T17:31:26+01:00",
"type": "804399ae-0de5-46b1-af48-aeefa3a00f7f",
"value": 15099,
"plans": [
"cf056804-b471-4906-95b6-850a12a90360",
"9756c5c1-8264-4f0b-b2f6-00ab4fec1fa9"
]
}
Response examples (200)
{
"name": "finance",
"slug": "finance",
"type": {
"name": "Mortgage Plan",
"uuid": "ecce3211-73d2-402c-a9b7-9d3ecab7aa55",
"created_at": "2025-08-27T17:31:26+01:00",
"updated_at": "2025-08-27T17:31:26+01:00"
},
"uuid": "8e43ca41-4a4d-4fbb-9a35-966d4811bf16",
"plans": {
"name": "Johns ISA",
"tags": "App\\Http\\Resources\\TagResource",
"type": "cash_account",
"uuid": "9786ef4d-8ea6-4638-b103-67493d42f8c9",
"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-08-27T17:31:26+01:00",
"valued_at": "2025-08-27T17:31:26+01:00",
"created_at": "2025-08-27T17:31:26+01:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-08-27T17:31:26+01:00",
"advice_area": "non_investment_insurance",
"inactive_at": "2025-08-27T17:31:26+01:00",
"review_date": "2024-08-27",
"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-08-26T17:31:26+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-08-27",
"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": "f1cfad6c-babd-4303-ac45-35d24b144ce6",
"colour": "#23852B",
"position": 5,
"created_at": "2025-08-27T17:31:26+01:00",
"updated_at": "2025-08-27T17:31:26+01:00",
"is_type_completed": false
},
"review_at": "2025-08-27T17:31:26+01:00",
"created_at": "2025-08-27T17:31:26+01:00",
"updated_at": "2025-08-27T17:31:26+01:00",
"group_uuids": [
"0ee4852e-b6f3-4b6c-b6ac-7311483c4d37"
],
"completed_at": "2025-08-27T17:31:26+01:00",
"participants": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "7fcc0934-8060-404b-8220-594e2cec2756",
"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-08-27T17:31:26+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-27T17:31:26+01:00",
"with_login": true,
"inactive_at": "2025-08-27",
"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-08-27T17:31:26+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-08-27T17:31:26+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-08-27T17:31:26+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-08-27T17:31:26+01:00"
},
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "17d090a7-56aa-4f2c-b712-6c38b4907727",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-08-27T17:31:26+01:00",
"updated_at": "2025-08-27T17:31:26+01:00",
"is_required": false,
"selection_options": [
"Coffee",
"Tea",
"Water"
]
}
],
"status_position": 4,
"task_board_uuid": "8d1e6132-d6b8-493f-93e3-bb56061238e1",
"assigned_to_uuids": [
"c53a1e09-fc2d-4e44-bd2e-381f1ad31116"
],
"participants_count": 4
}