Update claim of a plan

PUT /api/v1/plans/{plan_uuid}/claim/{uuid}
Personal access token & OAuth2

Path parameters

application/json

Body

Responses

PUT /api/v1/plans/{plan_uuid}/claim/{uuid} 
curl \
 --request PUT https://api.plannrcrm.com/api/v1/plans/plan_uuid/claim/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 '{"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
{
  "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 (200) 
{
  "uuid": "9c27bb6b-0818-408b-a0f1-aaf4de5b76ce",
  "client": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "02ca1abb-a666-475e-ae76-d362dcf9134f",
    "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"
}