Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
uuid
string Required
Body
-
name
string Name of the case
-
status
string The uuid of the status chosen for the case
-
status_position
integer The case status's new position on the status list. Starting from 1. Only used if you are formatting cases in a kanban layout.
-
assigned_to_uuids
array[string] Array of account UUIDs
-
group_uuids
array[string] UUIDs of groups that will be assigned when the case is created.
-
review_at
date Timestamp of when the case will be reviewed
-
type
string The uuid of the type chosen for the case
-
value
integer Expect value the case will generate in pennies
-
completed_at
date Timestamp of when the case was completed
-
plans
array[string] 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.
PUT
/api/v1/cases/{uuid}
curl \
--request PUT 'https://api.plannrcrm.com/api/v1/cases/uuid' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"name":"Annual review","status":"d7c17c76-eb00-4fd0-941f-731817ae845a","status_position":4,"assigned_to_uuids":["665d1ade-7644-48a4-a463-54b81bb8b5fc","83e07d1a-9a3a-4741-8f85-e5276b35a2a6"],"group_uuids":["ea3126c8-b33f-4a64-b20e-a5040d0db233","217c2bd8-772c-482e-9966-0e68a9daed3d"],"review_at":"2025-06-04T16:49:35+01:00","type":"b209416e-5bff-4bb4-b203-ae50056b8719","value":15099,"completed_at":"2025-06-04T16:49:35+01:00","plans":[null,null]}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "Annual review",
"status": "d7c17c76-eb00-4fd0-941f-731817ae845a",
"status_position": 4,
"assigned_to_uuids": [
"665d1ade-7644-48a4-a463-54b81bb8b5fc",
"83e07d1a-9a3a-4741-8f85-e5276b35a2a6"
],
"group_uuids": [
"ea3126c8-b33f-4a64-b20e-a5040d0db233",
"217c2bd8-772c-482e-9966-0e68a9daed3d"
],
"review_at": "2025-06-04T16:49:35+01:00",
"type": "b209416e-5bff-4bb4-b203-ae50056b8719",
"value": 15099,
"completed_at": "2025-06-04T16:49:35+01:00",
"plans": [
null,
null
]
}
Response examples (200)
{
"name": "finance",
"slug": "finance",
"type": {
"name": "Mortgage Plan",
"uuid": "37a64ff4-68a0-4b27-b4dd-760fd0b7641a",
"created_at": "2025-06-04T16:49:35+01:00",
"updated_at": "2025-06-04T16:49:35+01:00"
},
"uuid": "2ffcbe5f-ec48-4973-85b5-047424a732e0",
"plans": {
"name": "Johns ISA",
"tags": "App\\Http\\Resources\\TagResource",
"type": "cash_account",
"uuid": "0bcf871a-a19c-4856-92b4-85c3ea596436",
"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-06-04T16:49:35+01:00",
"valued_at": "2025-06-04T16:49:35+01:00",
"created_at": "2025-06-04T16:49:35+01:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-06-04T16:49:35+01:00",
"advice_area": "non_investment_insurance",
"inactive_at": "2025-06-04T16:49:35+01:00",
"review_date": "2024-06-04",
"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,
"latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
"original_valued_at": "2025-06-03T16:49:35+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-06-04",
"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": "84c1c408-586c-45ef-85ad-a6cb31b6c404",
"colour": "#23852B",
"position": 5,
"created_at": "2025-06-04T16:49:35+01:00",
"updated_at": "2025-06-04T16:49:35+01:00"
},
"review_at": "2025-06-04T16:49:35+01:00",
"created_at": "2025-06-04T16:49:35+01:00",
"updated_at": "2025-06-04T16:49:35+01:00",
"group_uuids": [
"e07e1ee0-da60-4534-9028-a18462d4c3df"
],
"completed_at": "2025-06-04T16:49:35+01:00",
"participants": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "6ba2e5d6-fbed-48ce-8495-9aa0ff0ecff2",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-04T16:49:35+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-04T16:49:35+01:00",
"with_login": true,
"inactive_at": "2025-06-04",
"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-06-04T16:49:35+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-04T16:49:35+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-06-04T16:49:35+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-04T16:49:35+01:00"
},
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "25af1c9f-68a9-4199-bf51-f2130b049728",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-06-04T16:49:35+01:00",
"updated_at": "2025-06-04T16:49:35+01:00",
"is_required": false,
"selection_options": [
"Coffee",
"Tea",
"Water"
]
}
],
"status_position": 4,
"task_board_uuid": "4895aef3-3f9c-4e62-b875-ecd4bfc12de2",
"assigned_to_uuids": [
"a9281f85-b717-4d0e-bc77-7026a6d45057"
],
"participants_count": 4
}