PATCH
/
insurance_policies
/
{insurance_policy_id}
cURL
curl --request PATCH \
  --url http://localhost:8080/insurance_policies/{insurance_policy_id} \
  --header 'Content-Type: application/json' \
  --header 'admin-api-key: <api-key>' \
  --data '
{
  "end_date": "2027-01-15",
  "external_policy_id": "<string>",
  "start_date": "2026-01-15",
  "status": "pending"
}
'
{
  "benefit_id": "<string>",
  "benefit_name": "<string>",
  "created_at": "<string>",
  "daily_premium_amount": {
    "currency": "INR",
    "value": 123
  },
  "dependant_ids": [
    "<string>"
  ],
  "grace_period_days": 123,
  "id": "<string>",
  "last_modified_at": "<string>",
  "monthly_premium_amount": {
    "currency": "INR",
    "value": 123
  },
  "nominee_details": "<unknown>",
  "primary_user_id": "<string>",
  "status": "pending",
  "end_date": "2027-01-15",
  "external_policy_id": "<string>",
  "metadata": {
    "dependant_mrn_map": {}
  },
  "start_date": "2026-01-15"
}

Authorizations

admin-api-key
string
header
required

Path Parameters

insurance_policy_id
string
required

Insurance Policy ID

Body

application/json
end_date
string | null
Example:

"2027-01-15"

external_policy_id
string | null
start_date
string | null
Example:

"2026-01-15"

status
null | enum<string>

Insurance policy lifecycle status.

Available options:
pending,
active,
requires_customer_renewal_in_grace,
requires_policy_reissuance,
requires_customer_renewal,
expired

Response

Insurance policy updated

benefit_id
string
required
benefit_name
string
required
created_at
string
required
daily_premium_amount
object
required
dependant_ids
string[]
required
grace_period_days
integer<int32>
required
id
string
required
last_modified_at
string
required
monthly_premium_amount
object
required
nominee_details
any
required
primary_user_id
string
required
status
enum<string>
required

Insurance policy lifecycle status.

Available options:
pending,
active,
requires_customer_renewal_in_grace,
requires_policy_reissuance,
requires_customer_renewal,
expired
end_date
string | null
Example:

"2027-01-15"

external_policy_id
string | null
metadata
object

Auxiliary metadata for an insurance policy.

start_date
string | null
Example:

"2026-01-15"