Update a case

PUT /api/v1/cases/{uuid}

Personal access token & O auth2

Headers

Path parameters

uuid string Required

application/json

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.

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- name string
  
  Name of the case
- slug string
  
  Slug of the case
- status object
  
  Case status
- type object
  
  Case type
- review_at string
  
  Timestamp of when the case should be reviewed
- assigned_to_uuids array[string]
  
  UUIDs of accounts that will be assigned to the case when it is created.
- group_uuids array[string]
  
  UUIDs of groups that will be assigned when the case is created.
- completed_at string
  
  Timestamp of when the case was completed
- value object
  
  Expected value of this case
- status_position integer
  
  The case status's position on the status list. Starting from 1. Only used if you are formatting cases in a kanban layout.
- participants_count integer
  
  The number of participants on the case
- participants object
  
  Participants on this case (if included)
- task_board_uuid string
  
  UUID of the task board
- plans object
  
  Plans in this case (if included)
- custom_fields array[object]
  
  Any custom fields on the model.

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":"f9e7aa75-2904-48a1-9f28-e2186f9cf1ed","status_position":4,"assigned_to_uuids":["2435b4f9-354d-4030-8eb5-d5400c90f9e1","dd707009-13cc-41db-991b-87c4a7a201b2"],"group_uuids":["5dee8ccd-8ce8-46fa-baf1-7f5b17c8f6f2","f50cc2f1-5f59-4d49-9345-81078f64f7b1"],"review_at":"2025-06-24T10:15:12+01:00","type":"04470841-080f-4f45-8435-b7ca03a285d6","value":15099,"completed_at":"2025-06-24T10:15:12+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": "f9e7aa75-2904-48a1-9f28-e2186f9cf1ed",
  "status_position": 4,
  "assigned_to_uuids": [
    "2435b4f9-354d-4030-8eb5-d5400c90f9e1",
    "dd707009-13cc-41db-991b-87c4a7a201b2"
  ],
  "group_uuids": [
    "5dee8ccd-8ce8-46fa-baf1-7f5b17c8f6f2",
    "f50cc2f1-5f59-4d49-9345-81078f64f7b1"
  ],
  "review_at": "2025-06-24T10:15:12+01:00",
  "type": "04470841-080f-4f45-8435-b7ca03a285d6",
  "value": 15099,
  "completed_at": "2025-06-24T10:15:12+01:00",
  "plans": [
    null,
    null
  ]
}

Response examples (200)

{
  "name": "finance",
  "slug": "finance",
  "type": {
    "name": "Mortgage Plan",
    "uuid": "09bea2ad-3055-4a88-9c46-43a7f5e5006c",
    "created_at": "2025-06-24T10:15:12+01:00",
    "updated_at": "2025-06-24T10:15:12+01:00"
  },
  "uuid": "8346cd78-58a8-42ed-9235-48e28cca314e",
  "plans": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "a9a92509-28f4-47df-9bec-40c3776335db",
    "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-24T10:15:12+01:00",
    "valued_at": "2025-06-24T10:15:12+01:00",
    "created_at": "2025-06-24T10:15:12+01:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2025-06-24T10:15:12+01:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2025-06-24T10:15:12+01:00",
    "review_date": "2024-06-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,
    "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
    "original_valued_at": "2025-06-23T10:15:12+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-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": "95575511-ba1f-4f44-a425-297f5030ad04",
    "colour": "#23852B",
    "position": 5,
    "created_at": "2025-06-24T10:15:12+01:00",
    "updated_at": "2025-06-24T10:15:12+01:00",
    "is_type_completed": false
  },
  "review_at": "2025-06-24T10:15:12+01:00",
  "created_at": "2025-06-24T10:15:12+01:00",
  "updated_at": "2025-06-24T10:15:12+01:00",
  "group_uuids": [
    "689336c2-203d-40b6-a4a8-29b0d0cfb806"
  ],
  "completed_at": "2025-06-24T10:15:12+01:00",
  "participants": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "0109502f-0662-4e53-8fda-28ab479855c4",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-06-24T10:15:12+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-06-24T10:15:12+01:00",
    "with_login": true,
    "inactive_at": "2025-06-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-06-24T10:15:12+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-06-24T10:15:12+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-24T10:15:12+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-06-24T10:15:12+01:00"
  },
  "custom_fields": [
    {
      "name": "Favourite Drink",
      "type": "string",
      "uuid": "157d1bfa-1228-409d-9e9f-8070eddc6046",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2025-06-24T10:15:12+01:00",
      "updated_at": "2025-06-24T10:15:12+01:00",
      "is_required": false,
      "selection_options": [
        "Coffee",
        "Tea",
        "Water"
      ]
    }
  ],
  "status_position": 4,
  "task_board_uuid": "94dda2da-9322-473e-b303-24491940f3fd",
  "assigned_to_uuids": [
    "a41442af-a00d-4f06-a990-ceab7f7249b9"
  ],
  "participants_count": 4
}