Update cover of a plan Run in API Explorer
Ask AI
Body
-
Cover type.
Value Description 3rd_party 3rd Party 3rd_party_fire_and_theft 3rd Party Fire And Theft accidental_damage Accidental Damage additional_rider_benefit Additional Rider Benefit ambulance Ambulance asu ASU buildings Buildings buildings_and_contents Buildings And Contents business Business comprehensive Comprehensive contents Contents critical_illness Critical Illness dental Dental extras Extras family_income_benefit Family Income Benefit hospital_cash Hospital Cash income_insurance Income Insurance life_assurance Life Assurance optical Optical personal_possessions Personal Possessions private Private private_hospital Private Hospital specialist Specialist tpd_total_permanent_disability TPD (Total Permanent Disability) trauma_insurance Trauma Insurance waiver_of_premium Waiver Of Premium unknown Unknown Values are
3rd_party,3rd_party_fire_and_theft,accidental_damage,additional_rider_benefit,ambulance,asu,buildings,buildings_and_contents,business,comprehensive,contents,critical_illness,dental,extras,family_income_benefit,hospital_cash,income_insurance,life_assurance,optical,personal_possessions,private,private_hospital,specialist,tpd_total_permanent_disability,trauma_insurance,waiver_of_premium, orunknown. -
Benefit amount in pennies. Only for protection policies.
-
Benefit status. Only for protection policies. Valid options are: active, inactive and proposed
Value Description active Active inactive Inactive proposed Proposed Values are
active,inactive, orproposed. -
Indexation. Only for protection policies.
-
Excess amount in pennies. Only for insurance policies.
-
The beneficiaries of the plan. UUID is a required property to update an exising beneficiary. Any beneficiaries UUIDs not included will be deleted on the plan. Any beneficiaries without a UUID are assumed to be a new beneficiary and will be created.
PUT
/api/v1/plans/{plan_uuid}/cover/{uuid}
curl \
--request PUT 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/cover/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"cover_type":"3rd_party","benefit_amount":892176,"benefit_status":"active","indexation":1.45,"excess":150000,"beneficiaries":[{"name":"John Smith","uuid":"296e8eaf-e324-45d3-a148-69959cee8200","percentage":20.02}]}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"cover_type": "3rd_party",
"benefit_amount": 892176,
"benefit_status": "active",
"indexation": 1.45,
"excess": 150000,
"beneficiaries": [
{
"name": "John Smith",
"uuid": "296e8eaf-e324-45d3-a148-69959cee8200",
"percentage": 20.02
}
]
}
Response examples (200)
{
"uuid": "91292fe9-442c-4330-a392-d30add3af2ad",
"client": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "c4b88b5e-4533-49ec-88ef-203b8a3efbd6",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-12-24T11:02:59+00:00",
"first_name": "Gareth",
"updated_at": "2025-12-24T11:02:59+00:00",
"with_login": true,
"inactive_at": "2025-12-24",
"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-12-24T11:02:59+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-12-24T11:02:59+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"last_interaction_at": "2025-12-24 11:02:59",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-12-24T11:02:59+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-12-24T11:02:59+00:00"
},
"excess": {
"amount": {
"example": "10000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£100.00",
"description": "Money amount formatted with currency"
}
},
"cover_type": "critical_illness",
"created_at": "2025-12-24T11:02:59+00:00",
"indexation": 1.4,
"updated_at": "2025-12-24T11:02:59+00:00",
"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"
}
},
"benefit_status": "active",
"benefit_frequency": "monthly"
}