Create cover for a plan Run in API Explorer
Body
-
Client who is claiming this cover. Must be able to access this plan. Only for protection policies.
-
Cover type.
Values are
asu,additional_rider_benefit,critical_illness,family_income_benefit,income_insurance,life_assurance,tpd_total_permanent_disability,trauma_insurance,waiver_of_premium,unknown,3rd_party,3rd_party_fire_and_theft,accidental_damage,ambulance,buildings,buildings_and_contents,business,comprehensive,contents,dental,extras,hospital_cash,optical,personal_possessions,private,private_hospital, orspecialist. -
Benefit amount in pennies. Only for protection policies.
-
Benefit frequency. Only for protection policies.
Value Description daily Daily weekly Weekly fortnightly Fortnightly four_weekly Four Weekly monthly Monthly bimonthly Bimonthly quarterly Quarterly biannually Biannually annually Annually adhoc Adhoc one_off One Off Values are
daily,weekly,fortnightly,four_weekly,monthly,bimonthly,quarterly,biannually,annually,adhoc, orone_off. -
Benefit status. Only for protection policies.
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.
curl \
--request POST 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/cover' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"client_uuid":"cb11bda7-9f56-4bb5-baf2-7f8d69ec869f","cover_type":"asu","benefit_amount":892176,"benefit_frequency":"daily","benefit_status":"active","indexation":1.45,"excess":150000,"beneficiaries":[{"name":"John Smith","percentage":50},{"name":"Jane Doe","percentage":20}]}'# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"client_uuid": "cb11bda7-9f56-4bb5-baf2-7f8d69ec869f",
"cover_type": "asu",
"benefit_amount": 892176,
"benefit_frequency": "daily",
"benefit_status": "active",
"indexation": 1.45,
"excess": 150000,
"beneficiaries": [
{
"name": "John Smith",
"percentage": 50
},
{
"name": "Jane Doe",
"percentage": 20
}
]
}{
"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"
}