Headers

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.

  • status string

    The uuid of the status chosen for the case

  • 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
POST /api/v1/cases
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/cases' \
 --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":"Patrick's Case","participants":["300a5b08-68bb-493a-b198-a39b95d9c670","be12e253-e30f-47ac-8088-14322da9e64d"],"status":"b178d4ec-adc9-494e-aba5-9b4dd57847b6","type":"abc9a1e5-1077-473d-8335-02f317289831","value":15099,"plans":["e1847979-29f4-4013-99d8-5147f0b3627b","41d2e147-2941-4359-875b-f3d5c31257c1"]}'
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": "Patrick's Case",
  "participants": [
    "300a5b08-68bb-493a-b198-a39b95d9c670",
    "be12e253-e30f-47ac-8088-14322da9e64d"
  ],
  "status": "b178d4ec-adc9-494e-aba5-9b4dd57847b6",
  "type": "abc9a1e5-1077-473d-8335-02f317289831",
  "value": 15099,
  "plans": [
    "e1847979-29f4-4013-99d8-5147f0b3627b",
    "41d2e147-2941-4359-875b-f3d5c31257c1"
  ]
}
Response examples (200)
{
  "name": "finance",
  "slug": "finance",
  "type": {
    "name": "Mortgage Plan",
    "uuid": "f22de676-929d-4055-ad02-ca233ec56115",
    "created_at": "2025-04-22T13:44:18+01:00",
    "updated_at": "2025-04-22T13:44:18+01:00"
  },
  "uuid": "9929f039-9d2c-4ba5-84d9-774ce367c4da",
  "plans": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "3aa393f2-b7b9-45a1-aba0-99da71972e34",
    "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-04-22T13:44:18+01:00",
    "valued_at": "2025-04-22T13:44:18+01:00",
    "created_at": "2025-04-22T13:44:18+01:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2025-04-22T13:44:18+01:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2025-04-22T13:44:18+01:00",
    "review_date": "2024-04-22",
    "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-04-21T13:44:18+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-04-22",
    "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": "c1c44b38-61b7-439d-8635-d2f45c2570bd",
    "colour": "#23852B",
    "position": 5,
    "created_at": "2025-04-22T13:44:18+01:00",
    "updated_at": "2025-04-22T13:44:18+01:00"
  },
  "created_at": "2025-04-22T13:44:18+01:00",
  "updated_at": "2025-04-22T13:44:18+01:00",
  "completed_at": "2025-04-22T13:44:18+01:00",
  "participants": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "4b1e3333-a47a-4447-9aee-64e913d0fd40",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-04-22T13:44:18+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-22T13:44:18+01:00",
    "with_login": true,
    "inactive_at": "2025-04-22",
    "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-04-22T13:44:18+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-04-22T13:44:18+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-04-22T13:44:18+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-04-22T13:44:18+01:00"
  },
  "custom_fields": [
    {
      "name": "Favourite Drink",
      "type": "string",
      "uuid": "97c4dc20-f3a1-418c-9ad8-96edb564b7a9",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2025-04-22T13:44:18+01:00",
      "updated_at": "2025-04-22T13:44:18+01:00",
      "is_required": false,
      "selection_options": [
        "Coffee",
        "Tea",
        "Water"
      ]
    }
  ],
  "status_position": 4,
  "task_board_uuid": "0f34789a-87f2-4cfd-91b2-c815a6caa4ae",
  "participants_count": 4
}