Create a case

POST /api/v1/cases
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string
application/json

Body Required

  • name string Required

    The name of the case

  • participants array[string]

    Account uuids belonging to the firm. Must include at least one client.

  • assigned_to_uuids array[string]

    Array of account UUIDs to assign to the case.

  • group_uuids array[string]

    UUIDs of groups that will be assigned when the case is created.

  • status string

    The uuid of the status chosen for the case

  • review_at string

    The date the case should be reviewed

  • type string

    The uuid of the type chosen for the case

  • value integer

    Expect value the case will generate in pennies

  • plans array[string]

    The uuids of the plans chosen for 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

      Hide status attributes Show status attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • colour string
      • position integer
      • is_type_completed boolean
    • type object

      Case type

      Hide type attributes Show type attributes object
      • uuid string
      • name string
      • created_at string
      • updated_at string
    • 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

      Hide value attributes Show value attributes object
      • amount object
        Hide amount attributes Show amount attributes object
        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object
        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object
        • example string
        • description string
    • 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)

      Hide participants attributes Show participants attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • firm string
      • primary_phone_number string
      • primary_email string
      • current_time_entry string
      • assigned_adviser string
      • assigned_administrator string
      • assigned_paraplanner string
      • introduced_by string
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • ownership_percentage integer
      • inactive_at string
      • custom_fields string
      • external_references string
    • task_board_uuid string

      UUID of the task board

    • plans object

      Plans in this case (if included)

      Hide plans attributes Show plans attributes object
      • uuid string
      • created_at string
      • updated_at string
      • opened_at string
      • name string
      • type string
      • sub_type string
      • abstract_type string
      • policy_number string
      • proposal_reference string
      • status string
      • inactive_at string
      • inactive_reason string
      • agency_in_your_name boolean
      • agency_in_your_name_from string
      • originally_sold_by_firm boolean
      • under_advice boolean
      • visible_on_client_portal boolean
      • include_in_client_valuation boolean
      • show_on_joint boolean
      • review_date string
      • on_panel boolean
      • is_group_scheme boolean
      • is_sub_group_scheme boolean
      • is_group_scheme_member boolean
      • advice_area string
      • main_account string
      • sub_accounts string
      • provider string
      • covers string
      • claims string
      • total_benefit_amount object
        Hide total_benefit_amount attributes Show total_benefit_amount attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • total_benefits object
        Hide total_benefits attributes Show total_benefits attributes object
        • critical_illness object
          Hide critical_illness attributes Show critical_illness attributes object
          • amount object
            Hide amount attributes Show amount attributes object
            • example string
            • description string
          • formatted object
            Hide formatted attributes Show formatted attributes object
            • example string
            • description string
          • currency object
            Hide currency attributes Show currency attributes object
            • example string
            • description string
        • family_income_benefit object
          Hide family_income_benefit attributes Show family_income_benefit attributes object
          • amount object
            Hide amount attributes Show amount attributes object
            • example string
            • description string
          • formatted object
            Hide formatted attributes Show formatted attributes object
            • example string
            • description string
          • currency object
            Hide currency attributes Show currency attributes object
            • example string
            • description string
      • latest_valuations string
      • value object
        Hide value attributes Show value attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • valued_at string
      • original_valued_at string
      • client string
      • accounts string
      • seller string
      • linked_owners string
      • linked_plans string
      • statistics object
        Hide statistics attribute Show statistics attribute object
        • recent_growth integer
      • cases string
      • tags string
      • is_wrap_product boolean
      • is_wrap_child boolean
      • wrap string
      • wrap_children string
      • can_be_deleted string
      • contract_enquiry_account string
      • custom_fields string
      • external_references string
    • custom_fields array[object]

      Any custom fields on the model.

      Hide custom_fields attributes Show custom_fields attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • name string
      • reference string
      • is_required boolean
      • value string
      • selection_options array[string]
      • help_text string
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":["be479ae8-6677-4be2-b350-e136b0b6b8ab","cf3d57f3-d191-452c-9510-7f15d07f1358"],"assigned_to_uuids":["cdc4a63c-d059-4850-97fd-185ae3112e76","e0d34a44-817d-4993-a51b-f531ef2e28b7"],"group_uuids":["14f6a4e0-a3d5-40d9-84a4-16a4e2b645b2","49d0b89a-1191-4ff3-a75a-0178d1e9b043"],"status":"a52f1531-3314-4429-872a-4459388ca038","review_at":"2025-07-17T16:23:20+01:00","type":"97bea613-add7-4b23-865c-7a50649240e4","value":15099,"plans":["0be6ac51-d6d4-4d7b-ac93-253351c5c965","dc8830f6-e41a-4d50-b0bc-f902987f8b03"]}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Patrick's Case",
  "participants": [
    "be479ae8-6677-4be2-b350-e136b0b6b8ab",
    "cf3d57f3-d191-452c-9510-7f15d07f1358"
  ],
  "assigned_to_uuids": [
    "cdc4a63c-d059-4850-97fd-185ae3112e76",
    "e0d34a44-817d-4993-a51b-f531ef2e28b7"
  ],
  "group_uuids": [
    "14f6a4e0-a3d5-40d9-84a4-16a4e2b645b2",
    "49d0b89a-1191-4ff3-a75a-0178d1e9b043"
  ],
  "status": "a52f1531-3314-4429-872a-4459388ca038",
  "review_at": "2025-07-17T16:23:20+01:00",
  "type": "97bea613-add7-4b23-865c-7a50649240e4",
  "value": 15099,
  "plans": [
    "0be6ac51-d6d4-4d7b-ac93-253351c5c965",
    "dc8830f6-e41a-4d50-b0bc-f902987f8b03"
  ]
}
Response examples (200) 
{
  "name": "finance",
  "slug": "finance",
  "type": {
    "name": "Mortgage Plan",
    "uuid": "90452f7e-c5d1-4bf7-9d5f-7194a56a8197",
    "created_at": "2025-07-17T16:23:20+01:00",
    "updated_at": "2025-07-17T16:23:20+01:00"
  },
  "uuid": "de752a92-eff2-4287-8dc8-99820661e7d7",
  "plans": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "38fefe02-5929-4223-971c-0235902d1fb8",
    "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-07-17T16:23:20+01:00",
    "valued_at": "2025-07-17T16:23:20+01:00",
    "created_at": "2025-07-17T16:23:20+01:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2025-07-17T16:23:20+01:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2025-07-17T16:23:20+01:00",
    "review_date": "2024-07-17",
    "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-07-16T16:23:20+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-07-17",
    "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": "3f917065-0237-404c-a9d0-4d3e7da5b5a7",
    "colour": "#23852B",
    "position": 5,
    "created_at": "2025-07-17T16:23:20+01:00",
    "updated_at": "2025-07-17T16:23:20+01:00",
    "is_type_completed": false
  },
  "review_at": "2025-07-17T16:23:20+01:00",
  "created_at": "2025-07-17T16:23:20+01:00",
  "updated_at": "2025-07-17T16:23:20+01:00",
  "group_uuids": [
    "64be8ab5-2323-466c-ad63-2ec6d6d853fa"
  ],
  "completed_at": "2025-07-17T16:23:20+01:00",
  "participants": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "8761c16d-3cc5-40ce-9918-8f6b10dae7a4",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-07-17T16:23:20+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-07-17T16:23:20+01:00",
    "with_login": true,
    "inactive_at": "2025-07-17",
    "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-07-17T16:23:20+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-07-17T16:23:20+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-07-17T16:23:20+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-07-17T16:23:20+01:00"
  },
  "custom_fields": [
    {
      "name": "Favourite Drink",
      "type": "string",
      "uuid": "876bf278-c6be-4719-98b4-4c66c5cf7a41",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2025-07-17T16:23:20+01:00",
      "updated_at": "2025-07-17T16:23:20+01:00",
      "is_required": false,
      "selection_options": [
        "Coffee",
        "Tea",
        "Water"
      ]
    }
  ],
  "status_position": 4,
  "task_board_uuid": "d62a3539-4276-43d1-99b7-0da0e1dce596",
  "assigned_to_uuids": [
    "72e404fb-480f-4afd-995a-31b6de8c0a0c"
  ],
  "participants_count": 4
}