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.
PUT
/api/v1/cases/{uuid}
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":"03ef42d4-ddfe-4101-80e5-0b98d6e87227","status_position":4,"assigned_to_uuids":["25de8247-709a-495f-9938-b05a465e1c2f","798bfb7d-6baf-40a5-82de-b67b0eca33b8","662e2e5a-f89b-40b6-bda0-afdea541d742"],"group_uuids":["bcafec76-688b-4743-9be5-1b5c8fb9edf4","8baa2e53-8427-497f-a5e2-e5a10e1e8b78","e752cb1b-5148-4b52-bdce-e7ef89a04449"],"review_at":"2026-05-20T13:55:09+01:00","type":"4029cc33-be68-4e4f-9ba8-f8d00ff13aef","value":15099,"completed_at":"2026-05-20T13:55:09+01:00","plans":["6054981b-68fc-4d86-a050-c2172c99245a","e1bf6532-f98b-4969-8cf4-ac46682b4731","d5f14fcd-fafa-4c5e-8b33-6364452d45fa"],"custom_fields":{"ongoing_case":"Not Ongoing"}}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "Annual review",
"status": "03ef42d4-ddfe-4101-80e5-0b98d6e87227",
"status_position": 4,
"assigned_to_uuids": [
"25de8247-709a-495f-9938-b05a465e1c2f",
"798bfb7d-6baf-40a5-82de-b67b0eca33b8",
"662e2e5a-f89b-40b6-bda0-afdea541d742"
],
"group_uuids": [
"bcafec76-688b-4743-9be5-1b5c8fb9edf4",
"8baa2e53-8427-497f-a5e2-e5a10e1e8b78",
"e752cb1b-5148-4b52-bdce-e7ef89a04449"
],
"review_at": "2026-05-20T13:55:09+01:00",
"type": "4029cc33-be68-4e4f-9ba8-f8d00ff13aef",
"value": 15099,
"completed_at": "2026-05-20T13:55:09+01:00",
"plans": [
"6054981b-68fc-4d86-a050-c2172c99245a",
"e1bf6532-f98b-4969-8cf4-ac46682b4731",
"d5f14fcd-fafa-4c5e-8b33-6364452d45fa"
],
"custom_fields": {
"ongoing_case": "Not Ongoing"
}
}
Response examples (200)
{
"uuid": "b35ba092-84c2-44fa-bb7c-7366a5a99e2e",
"created_at": "2026-05-20T13:55:09+01:00",
"updated_at": "2026-05-20T13:55:09+01:00",
"name": "finance",
"slug": "finance",
"status": {
"uuid": "4c5200d0-d042-4fe4-931f-16b922c073d1",
"created_at": "2026-05-20T13:55:09+01:00",
"updated_at": "2026-05-20T13:55:09+01:00",
"name": "To Be Reviewed",
"colour": "#23852B",
"position": 5,
"is_type_completed": false
},
"type": {
"uuid": "b5cc8a36-5c7b-4d3b-89a5-aeb18a2c8f33",
"name": "Mortgage Plan",
"created_at": "2026-05-20T13:55:09+01:00",
"updated_at": "2026-05-20T13:55:09+01:00"
},
"review_at": "2026-05-20T13:55:09+01:00",
"assigned_to_uuids": [
"e6e5274a-04be-4705-8ec8-444b55bc3cf3"
],
"group_uuids": [
"f26d36e6-c244-43b7-bbf0-eec8ea6663f7"
],
"completed_at": "2026-05-20T13:55:09+01: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": "cce86a72-4f82-4874-b8f0-398883d928f8",
"created_at": "2026-05-20T13:55:09+01:00",
"updated_at": "2026-05-20T13:55:09+01: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": "App\\Http\\Resources\\FirmResource",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"business_unit": "App\\Http\\Resources\\BusinessUnitResource",
"groups": "App\\Http\\Resources\\GroupResource",
"tags": "App\\Http\\Resources\\TagResource",
"owners": "App\\Http\\Resources\\AccountResource",
"first_contact_date": "2026-05-20T13:55:09+01:00",
"next_review_date": "2026-05-20T13:55:09+01:00",
"previous_review_date": "2026-05-20T13:55:09+01:00",
"anniversary_review_date": "2026-05-20T13:55:09+01:00",
"terms_of_business_at": "2026-05-20T13:55:09+01:00",
"client_agreement_at": "2026-05-20T13:55:09+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"circles": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"inactive_at": "2026-05-20",
"last_interaction_at": "2026-05-20 13:55:09",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"task_board_uuid": "f45a88ec-f0c3-412e-8ebe-4dc5b786b4cf",
"plans": {
"uuid": "4270bfdb-e778-452d-b6ae-e98f96d5d5ea",
"created_at": "2026-05-20T13:55:09+01:00",
"updated_at": "2026-05-20T13:55:09+01:00",
"opened_at": "2026-05-20T13:55:09+01: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-05-20T13:55:09+01:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-05-20",
"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-05-20",
"on_panel": true,
"is_group_scheme": false,
"is_sub_group_scheme": false,
"is_group_scheme_member": false,
"advice_area": "non_investment_insurance",
"main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
"sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
"provider": "App\\Http\\Resources\\Plans\\ProviderResource",
"covers": "App\\Http\\Resources\\Plans\\CoverResource",
"claims": "App\\Http\\Resources\\Plans\\ClaimResource",
"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": "App\\Http\\Resources\\Plans\\ValuationResource",
"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-05-20T13:55:09+01:00",
"original_valued_at": "2026-05-19T13:55:09+01:00",
"client": "App\\Http\\Resources\\AccountResource",
"accounts": "App\\Http\\Resources\\AccountResource",
"seller": "App\\Http\\Resources\\AccountResource",
"linked_owners": "App\\Http\\Resources\\AccountResource",
"linked_plans": "App\\Http\\Resources\\Plans\\PlanResource",
"visible_to_circles": "App\\Http\\Resources\\CircleResource",
"statistics": {
"recent_growth": 100
},
"cases": "App\\Http\\Resources\\CasesResource",
"tags": "App\\Http\\Resources\\TagResource",
"is_wrap_product": false,
"is_wrap_child": false,
"wrap": "App\\Http\\Resources\\Plans\\PlanResource",
"wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
"linked_policy_numbers": "App\\Http\\Resources\\Plans\\LinkedPolicyNumberResource",
"can_be_deleted": "false",
"contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"custom_fields": [
{
"uuid": "89e9b847-5fd1-4637-a8d1-f10d1dda8a8e",
"created_at": "2026-05-20T13:55:09+01:00",
"updated_at": "2026-05-20T13:55:09+01: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."
}
]
}