Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Body Required
-
client_uuid string
Client who is claiming this cover. Must be able to access this plan.
-
Claim amount in pennies.
-
Claim start date
-
claim_end_date date
Claim end date
-
claim_notes date
Claim notes
POST
/api/v1/plans/{plan_uuid}/claim
curl \
--request POST https://api.plannrcrm.com/api/v1/plans/plan_uuid/claim \
--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 '{"client_uuid":"682c395d-4f33-488a-aa6f-24b20371720e","claim_amount":892176,"claim_start_date":"2024-02-20 10:13:04","claim_end_date":"2030-02-20 10:13:04","claim_notes":"Claim notes"}'
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
{
"client_uuid": "682c395d-4f33-488a-aa6f-24b20371720e",
"claim_amount": 892176,
"claim_start_date": "2024-02-20 10:13:04",
"claim_end_date": "2030-02-20 10:13:04",
"claim_notes": "Claim notes"
}
Response examples (201)
{
"uuid": "1b223d45-2212-4cdf-93f1-9fadcbd71e13",
"client": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "0d3cd200-0b29-4522-bc74-5771067a9d52",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-02-20T10:13:04+00:00",
"first_name": "Gareth",
"updated_at": "2025-02-20T10:13:04+00:00",
"with_login": true,
"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-02-20T10:13:04+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-02-20T10:13:04+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-02-20T10:13:04+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-02-20T10:13:04+00:00"
},
"created_at": "2025-02-20T10:13:04+00:00",
"updated_at": "2025-02-20T10:13:04+00:00",
"claim_notes": "Claim notes",
"claim_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"
}
},
"claim_end_date": "2030-02-20",
"claim_start_date": "2024-02-20"
}