Skip to main content
PATCH
/
cases
/
{case_id}
/
life-insurance
/
{policy_id}
Update policy
curl --request PATCH \
  --url https://api.example.com/v1/cases/{case_id}/life-insurance/{policy_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "policy_type": "term_life",
  "carrier_name": "<string>",
  "policy_number": "<string>",
  "status": "active",
  "death_benefit": 123,
  "cash_value": 123,
  "beneficiaries": [
    {
      "name": "<string>",
      "relationship": "<string>",
      "percentage_share": 123,
      "designation": "primary",
      "is_irrevocable": true
    }
  ],
  "employer_name": "<string>",
  "claim_status": "not_filed",
  "claim_filed_date": "2023-12-25",
  "institution_contact_id": "<string>",
  "notes": "<string>"
}
'
{
  "data": {
    "id": "01K9LI01AJ0T11HRYE78AN7LLL",
    "case_id": "<string>",
    "policy_type": "whole_life",
    "carrier_name": "Northwestern Mutual",
    "policy_number": "***1234",
    "status": "active",
    "death_benefit": 250000,
    "cash_value": 45000,
    "beneficiaries": [
      {
        "name": "<string>",
        "relationship": "<string>",
        "percentage_share": 123,
        "designation": "primary",
        "is_irrevocable": true
      }
    ],
    "premium_status": "current",
    "employer_name": "<string>",
    "claim_status": "not_filed",
    "claim_filed_date": "2023-12-25",
    "claim_paid_date": "2023-12-25",
    "claim_paid_amount": 123,
    "institution_contact_id": "<string>",
    "notes": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://api.hellosunset.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
case_id
string
required

Unique case identifier (ULID format).

​
policy_id
string
required

Body

application/json
​
policy_type
enum<string>
required
Available options:
term_life,
whole_life,
universal_life,
variable_life,
group_employer,
group_government,
supplemental,
accidental_death,
annuity_with_death_benefit
​
carrier_name
string
required
​
policy_number
string

Full policy number.

​
status
enum<string>
Available options:
active,
inactive,
lapsed,
claimed,
paid_out,
denied,
unknown
​
death_benefit
number<double>
​
cash_value
number<double>
​
beneficiaries
object[]
​
employer_name
string
​
claim_status
enum<string>
Available options:
not_filed,
filed,
under_review,
approved,
paid,
denied
​
claim_filed_date
string<date>
​
institution_contact_id
string
​
notes
string

Response

Policy updated.

​
data
object