Update a beneficiary of a plan
Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Body
-
name
string Name of the beneficiary.
-
percentage
number Percentage due to the beneficiary.
PUT
/api/v1/plans/{plan_uuid}/beneficiary/{uuid}
curl \
--request PUT 'https://api.plannrcrm.com/api/v1/plans/plan_uuid/beneficiary/uuid' \
--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":"John Smith","percentage":50.75}'
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": "John Smith",
"percentage": 50.75
}
Response examples (200)
{
"name": "Beneficiary name",
"uuid": "571b6f6a-ade7-431c-97e5-6838f4cc6f57",
"cover": {
"uuid": "624921fd-ff1f-41d4-bf00-bb1a4a65c5d9",
"client": "App\\Http\\Resources\\AccountResource",
"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-04-22T13:44:20+01:00",
"indexation": 1.4,
"updated_at": "2025-04-22T13:44:20+01: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"
},
"created_at": "2025-04-22T13:44:20+01:00",
"percentage": 50,
"updated_at": "2025-04-22T13:44:20+01:00"
}