Create claim for a plan

POST /api/v1/plans/{plan_uuid}/claim
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • plan_uuid string Required
application/json

Body Required

  • client_uuid string

    Client who is claiming this cover. Must be able to access this plan.

  • claim_amount integer Required

    Claim amount in pennies.

  • claim_start_date date Required

    Claim start date

  • claim_end_date date

    Claim end date

  • claim_notes date

    Claim notes

Responses

  • 201 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • claim_amount object

      Claim amount

      Hide claim_amount attributes Show claim_amount attributes object
      • amount object
        Hide amount attributes Show amount attributes object
        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object
        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object
        • example string
        • description string
    • claim_start_date string

      Claim start date

    • claim_end_date string

      Claim end date

    • claim_notes string

      Claim notes

    • client object

      Client this claim is for

      Hide client attributes Show client attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • firm string
      • primary_phone_number string
      • primary_email string
      • current_time_entry string
      • assigned_adviser string
      • assigned_administrator string
      • assigned_paraplanner string
      • introduced_by string
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • custom_fields string
      • external_references string
POST /api/v1/plans/{plan_uuid}/claim 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/claim' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"client_uuid":"e0bdec2a-2b37-4552-a367-831ec7d82d1d","claim_amount":892176,"claim_start_date":"2024-08-07 13:41:43","claim_end_date":"2030-08-07 13:41:43","claim_notes":"Claim notes"}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "client_uuid": "e0bdec2a-2b37-4552-a367-831ec7d82d1d",
  "claim_amount": 892176,
  "claim_start_date": "2024-08-07 13:41:43",
  "claim_end_date": "2030-08-07 13:41:43",
  "claim_notes": "Claim notes"
}
Response examples (201) 
{
  "uuid": "b4ca6454-e062-437b-bf90-a8a164d53b72",
  "client": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "105ffd67-fc6d-4bae-b838-6883417cdfdd",
    "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-08-07T13:41:43+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-08-07T13:41:43+01:00",
    "with_login": true,
    "inactive_at": "2025-08-07",
    "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-08-07T13:41:43+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-08-07T13:41:43+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-08-07T13:41:43+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-08-07T13:41:43+01:00"
  },
  "created_at": "2025-08-07T13:41:43+01:00",
  "updated_at": "2025-08-07T13:41:43+01: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-08-07",
  "claim_start_date": "2024-08-07"
}