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

Headers

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

Body

  • name string Required

    The name of the case

  • participants array[string(uuid)]

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

  • assigned_to_uuids array[string(uuid)]

    Array of account UUIDs to assign to the case.

  • group_uuids array[string(uuid)]

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

  • status string(uuid)

    The uuid of the status chosen for the case

  • review_at string(date-time)

    The date the case should be reviewed

  • type string(uuid)

    The uuid of the type chosen for the case

  • value integer

    Expect value the case will generate in pennies

  • plans array[string(uuid)]

    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
      • photo_url 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
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • permissions object
        Hide permissions attributes Show permissions attributes object
        • firm:read array[string]
        • network:read array[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
      • shown_on_circles 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
      • visible_to_circles 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
      • linked_policy_numbers 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":["b3f095a4-7f25-4872-9d3d-7bdb9c7467b5","33aa9947-0873-4471-94bb-304ca6cb73c0","d2335ca1-9050-4a64-8507-463ebe3daba7"],"assigned_to_uuids":["8d756177-cf0e-4366-8290-285b611fa156","e3337240-424a-4dc0-8103-3e20283ae713","45d15243-8065-4495-b780-968d4ad071ed"],"group_uuids":["c24cae29-efcd-4254-bb49-2890195bf4ad","b14959b2-1319-4990-87ac-8911f68aa93f","f2420bcf-9b02-45e0-a7e8-84e00c5da520"],"status":"c664a133-3e88-4813-81be-a007dd13f182","review_at":"2026-04-13T17:23:50+01:00","type":"704353d8-cf62-487a-b491-005f099eb38a","value":15099,"plans":["f0287e05-df89-457e-a8e8-70c09ea3645f","67be16de-de2f-4624-b819-43943c295dcf","2b7a1c33-ac24-44a7-903a-bf539f9325ff"]}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Patrick's Case",
  "participants": [
    "b3f095a4-7f25-4872-9d3d-7bdb9c7467b5",
    "33aa9947-0873-4471-94bb-304ca6cb73c0",
    "d2335ca1-9050-4a64-8507-463ebe3daba7"
  ],
  "assigned_to_uuids": [
    "8d756177-cf0e-4366-8290-285b611fa156",
    "e3337240-424a-4dc0-8103-3e20283ae713",
    "45d15243-8065-4495-b780-968d4ad071ed"
  ],
  "group_uuids": [
    "c24cae29-efcd-4254-bb49-2890195bf4ad",
    "b14959b2-1319-4990-87ac-8911f68aa93f",
    "f2420bcf-9b02-45e0-a7e8-84e00c5da520"
  ],
  "status": "c664a133-3e88-4813-81be-a007dd13f182",
  "review_at": "2026-04-13T17:23:50+01:00",
  "type": "704353d8-cf62-487a-b491-005f099eb38a",
  "value": 15099,
  "plans": [
    "f0287e05-df89-457e-a8e8-70c09ea3645f",
    "67be16de-de2f-4624-b819-43943c295dcf",
    "2b7a1c33-ac24-44a7-903a-bf539f9325ff"
  ]
}
Response examples (200) 
{
  "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"
  }
}