Create a case

POST /api/v1/cases

Personal access token & OAuth2

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
- 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
  
  Additional properties are allowed.
- type object
  
  Case type
  
  Additional properties are allowed.
- completed_at string
  
  Timestamp of when the case was completed
- value object
  
  Expected value of this case
  
  Additional properties are allowed.
- 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)
  
  Additional properties are allowed.
- task_board_uuid string
  
  UUID of the task board
- plans object
  
  Plans in this case (if included)
  
  Additional properties are allowed.
- custom_fields array[object]
  
  Any custom fields on the model.
  
  Additional properties are allowed.

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":["918a2da5-332a-421f-bb67-0e1daddceb0b","b9f2e020-959c-4d04-93f8-d9a8849e7b13"],"status":"c9182815-2a13-41a8-9b26-2a0eafa21614","type":"d67855ee-958e-45e0-9524-43dd489c17ee","value":15099,"plans":["cfb10989-4d59-4990-a57e-2bc70d3306de","fa1bd7e8-b7a9-46a1-8650-2d72d556be7b"]}'

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": [
    "918a2da5-332a-421f-bb67-0e1daddceb0b",
    "b9f2e020-959c-4d04-93f8-d9a8849e7b13"
  ],
  "status": "c9182815-2a13-41a8-9b26-2a0eafa21614",
  "type": "d67855ee-958e-45e0-9524-43dd489c17ee",
  "value": 15099,
  "plans": [
    "cfb10989-4d59-4990-a57e-2bc70d3306de",
    "fa1bd7e8-b7a9-46a1-8650-2d72d556be7b"
  ]
}

Response examples (200)

{
  "name": "finance",
  "slug": "finance",
  "type": {
    "name": "Mortgage Plan",
    "uuid": "3ee2f520-217d-4c33-a5c5-18826457ff37",
    "created_at": "2025-02-20T10:13:02+00:00",
    "updated_at": "2025-02-20T10:13:02+00:00"
  },
  "uuid": "83eb6549-db0b-44af-88d8-1ef9dae6f76c",
  "plans": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "da1bd8ef-4431-47e3-a3c5-a3e4d3e671b6",
    "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",
    "on_panel": true,
    "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
    "sub_type": "lifetime isa",
    "opened_at": "2025-02-20T10:13:02+00:00",
    "valued_at": "2025-02-20T10:13:02+00:00",
    "created_at": "2025-02-20T10:13:02+00:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2025-02-20T10:13:02+00:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2025-02-20T10:13:02+00:00",
    "review_date": "2024-02-20",
    "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",
    "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-02-20",
    "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": "ed3d603a-a284-4ada-9f7f-24e29ce7d5e9",
    "colour": "#23852B",
    "position": 5,
    "created_at": "2025-02-20T10:13:02+00:00",
    "updated_at": "2025-02-20T10:13:02+00:00"
  },
  "created_at": "2025-02-20T10:13:02+00:00",
  "updated_at": "2025-02-20T10:13:02+00:00",
  "completed_at": "2025-02-20T10:13:02+00:00",
  "participants": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "ace1c95f-c230-4c95-acbd-2c4b84bed3cb",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-02-20T10:13:02+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-02-20T10:13:02+00:00",
    "with_login": true,
    "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-02-20T10:13:02+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-02-20T10:13:02+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2025-02-20T10:13:02+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-02-20T10:13:02+00:00"
  },
  "custom_fields": [
    {
      "name": "Favourite Drink",
      "type": "string",
      "uuid": "c2bd5850-c366-483b-8b76-359d4e075e27",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2025-02-20T10:13:02+00:00",
      "updated_at": "2025-02-20T10:13:02+00:00",
      "is_required": false,
      "selection_options": [
        "Coffee",
        "Tea",
        "Water"
      ]
    }
  ],
  "status_position": 4,
  "task_board_uuid": "5a1332a0-98e3-4ed8-8a79-88787b3b4220",
  "participants_count": 4
}