---
schema_version: "1"
id: 51c84021611a3d7026dd4243ecf8aebd1411e305a0563e114c7511efe54434e7
title: Claim (GET, PATCH)
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/insurance_developer_guide/connect_resources_claim.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_claim.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: c667331d96666915c0aca1415b98c8085ab68679be177508dabdbca4143fea83
description: Get or update a claim record and its associated claim items and participants.
---
# Claim (GET, PATCH)

Get or update a claim record and its associated claim items and participants.

## Resource

{claimId} is a placeholder.

/connect/claims/{claimId}

## Resource Example

Replace {yourInstance} with the My Domain name of your Salesforce org.

https://{yourInstance}.salesforce.com/services/data/v68.0/connect/claims/0Zkxx000000001dEAA

## Available Version

65.0

## HTTP Methods

GET, PATCH

## Path Parameter for GET and PATCH

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| claimId | String | ID of the claim to get or update the details for. | Required | 65.0 |

## Response Body for GET

[Claim Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_claim_output.htm "Output representation for the details of a claim record.")

## Request Body for PATCH

### JSON Example

{
  "name": "Claim for Auto Accident",
  "lossDate": "2025-10-23T15:41:10.446Z",
  "claimLossDate": "2025-09-15",
  "claimType": "Auto",
  "claimReason": "Rear-end collision",
  "claimReasonType": "Accident",
  "lossType": "Accident",
  "insurancePolicyId": "0YTx0000000001qEAA",
  "productCode": "AutoClaimRoot",
  "accountId": "001xx000003DGQyAAO",
  "expenseReserveAmount": 750.50,
  "expenseReserveAdjustmentReason": "Initial expense reserve",
  "lossReserveAmount": 5000.00,
  "lossReserveAdjustmentReason": "Initial loss reserve",
  "additionalFields": {
    "PoliceReportNumber": "SF2025-00817",
    "IsTotalLoss": false,
    "ReportedDate\_\_c": "2025-09-15"
  },
  "options": {
    "executeConfigurationRules": "false"
  },
  "attributes": {
    "list": \[
      {
        "apiName": "WeatherConditions",
        "value": "Clear and Sunny"
      },
      {
        "apiName": "NumberOfVehicles",
        "value": "2"
      }
    \]
  },
  "items": {
    "list": \[
      {
        "instanceKey": "item\_vehicle\_damage\_01",
        "name": "Damaged Rear Bumper and Trunk",
        "productCode": "AUTO-SEDAN-2023",
        "category": "Auto Physical Damage",
        "insuredItemId": "02ixx0000004l5sAAA",
        "insurancePolicyCoverageId": "0cvxx000000AbCdEfG",
        "attributes": {
          "list": \[
            {
              "apiName": "DamageSeverity",
              "value": "Moderate"
            }
          \]
        },
        "additionalFields": {
          "RepairEstimate": 2750,
          "Date\_Damage\_First\_Noticed\_\_c": "2025-09-15"
        },
        "relatedObjects": {
          "list": \[
            {
              "relatedRecordId": "001xx000003DGQzAAP",
              "relatedRecordObjName": "Account"
            }
          \]
        },
        "participantInstanceKey": "participant\_driver\_01",
        "action": "update"
      }
    \]
  },
  "participants": {
    "list": \[
      {
        "instanceKey": "participant\_driver\_01",
        "contactId": "003xx000003DGQyAAO",
        "accountId": "001xx000003DGQyAAO",
        "insurancePolicyParticipantId": "0pPxx000000001qEAA",
        "isInjured": false,
        "roles": \[
          "Driver",
          "Claimant"
        \],
        "additionalFields": {
          "StatementTaken": true
        },
        "action": "update"
      }
    \]
  }
}

### Properties

<table class="featureTable sort_table" summary="">





            <thead class="thead sorted" align="left">
              <tr>
                <th class="featureTableHeader  " id="d141492e224">Name</th>

                <th class="featureTableHeader  " id="d141492e227">Type</th>

                <th class="featureTableHeader  " id="d141492e230">Description</th>

                <th class="featureTableHeader  " id="d141492e233">Required or Optional</th>

                <th class="featureTableHeader  " id="d141492e236">Available Version</th>

              </tr>

            </thead>

            <tbody class="tbody">
              <tr>
                <td class="entry" headers="d141492e224" data-title="Name"><samp class="codeph nolang">accountId</samp></td>

                <td class="entry" headers="d141492e227" data-title="Type">String</td>

                <td class="entry" headers="d141492e230" data-title="Description">ID of the account that's associated with the claim.</td>

                <td class="entry" headers="d141492e233" data-title="Required or Optional">Optional</td>

                <td class="entry" headers="d141492e236" data-title="Available Version">65.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d141492e224" data-title="Name"><samp class="codeph nolang">additionalFields</samp></td>

                <td class="entry" headers="d141492e227" data-title="Type">Object</td>

                <td class="entry" headers="d141492e230" data-title="Description">Additional standard or custom fields that are used to create or update
                  insurance claim.</td>

                <td class="entry" headers="d141492e233" data-title="Required or Optional">Optional</td>

                <td class="entry" headers="d141492e236" data-title="Available Version">65.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d141492e224" data-title="Name"><samp class="codeph nolang">attributes</samp></td>

                <td class="entry" headers="d141492e227" data-title="Type">
                  <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_claim_attribute_input.htm" title="Input representation for claim attributes.">Claim Attribute Input[]</a>
                </td>

                <td class="entry" headers="d141492e230" data-title="Description">Attributes of the claim product.</td>

                <td class="entry" headers="d141492e233" data-title="Required or Optional">Optional</td>

                <td class="entry" headers="d141492e236" data-title="Available Version">65.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d141492e224" data-title="Name"><samp class="codeph nolang">claimLossDate</samp></td>

                <td class="entry" headers="d141492e227" data-title="Type">String</td>

                <td class="entry" headers="d141492e230" data-title="Description">Date when the loss occurred.
                  <p class="p"> This parameter doesn't accept time of
                    incident. To specify both the date and time of loss, use the
                    <samp class="codeph nolang">lossDate</samp> parameter.
                  </p>

                </td>

                <td class="entry" headers="d141492e233" data-title="Required or Optional">Optional</td>

                <td class="entry" headers="d141492e236" data-title="Available Version">66.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d141492e224" data-title="Name"><samp class="codeph nolang">claimReason</samp></td>

                <td class="entry" headers="d141492e227" data-title="Type">String</td>

                <td class="entry" headers="d141492e230" data-title="Description">Reason for the claim.</td>

                <td class="entry" headers="d141492e233" data-title="Required or Optional">Optional</td>

                <td class="entry" headers="d141492e236" data-title="Available Version">65.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d141492e224" data-title="Name"><samp class="codeph nolang">claimReasonType</samp></td>

                <td class="entry" headers="d141492e227" data-title="Type">String</td>

                <td class="entry" headers="d141492e230" data-title="Description">Category that the claim reason belongs to.</td>

                <td class="entry" headers="d141492e233" data-title="Required or Optional">Optional</td>

                <td class="entry" headers="d141492e236" data-title="Available Version">65.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d141492e224" data-title="Name"><samp class="codeph nolang">claimType</samp></td>

                <td class="entry" headers="d141492e227" data-title="Type">String</td>

                <td class="entry" headers="d141492e230" data-title="Description">Type of claim.</td>

                <td class="entry" headers="d141492e233" data-title="Required or Optional">Optional</td>

                <td class="entry" headers="d141492e236" data-title="Available Version">65.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d141492e224" data-title="Name"><samp class="codeph nolang">expenseReserve​AdjustmentReason</samp></td>

                <td class="entry" headers="d141492e227" data-title="Type">String</td>

                <td class="entry" headers="d141492e230" data-title="Description">Reason for the expense reserve adjustment.</td>

                <td class="entry" headers="d141492e233" data-title="Required or Optional">Optional</td>

                <td class="entry" headers="d141492e236" data-title="Available Version">68.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d141492e224" data-title="Name"><samp class="codeph nolang">expenseReserve​Amount</samp></td>

                <td class="entry" headers="d141492e227" data-title="Type">Double</td>

                <td class="entry" headers="d141492e230" data-title="Description">Amount that's reserved to cover potential expenses while handling the
                  claim, such as administrative or legal costs.</td>

                <td class="entry" headers="d141492e233" data-title="Required or Optional">Optional</td>

                <td class="entry" headers="d141492e236" data-title="Available Version">68.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d141492e224" data-title="Name"><samp class="codeph nolang">insurance​PolicyId</samp></td>

                <td class="entry" headers="d141492e227" data-title="Type">String</td>

                <td class="entry" headers="d141492e230" data-title="Description">ID of the insurance policy on which the claim is raised.</td>

                <td class="entry" headers="d141492e233" data-title="Required or Optional">Optional</td>

                <td class="entry" headers="d141492e236" data-title="Available Version">65.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d141492e224" data-title="Name"><samp class="codeph nolang">items</samp></td>

                <td class="entry" headers="d141492e227" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_claim_item_input.htm" title="Input representation for a claim item.">Claim Item Input[]</a></td>

                <td class="entry" headers="d141492e230" data-title="Description">Details of the items that are associated with the claim.</td>

                <td class="entry" headers="d141492e233" data-title="Required or Optional">Optional</td>

                <td class="entry" headers="d141492e236" data-title="Available Version">65.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d141492e224" data-title="Name"><samp class="codeph nolang">lossDate</samp></td>

                <td class="entry" headers="d141492e227" data-title="Type">Date</td>

                <td class="entry" headers="d141492e230" data-title="Description">Date and time when the loss occurred.
                  <p class="p">You must specify both the date
                    and time of the incident; otherwise, the API returns an error. To specify
                    only the date of loss, use the
                    <samp class="codeph nolang">claimLossDate</samp> parameter.
                  </p>

                </td>

                <td class="entry" headers="d141492e233" data-title="Required or Optional">Optional</td>

                <td class="entry" headers="d141492e236" data-title="Available Version">65.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d141492e224" data-title="Name"><samp class="codeph nolang">lossReserve​AdjustmentReason</samp></td>

                <td class="entry" headers="d141492e227" data-title="Type">String</td>

                <td class="entry" headers="d141492e230" data-title="Description">Reason for the loss reserve adjustment.</td>

                <td class="entry" headers="d141492e233" data-title="Required or Optional">Optional</td>

                <td class="entry" headers="d141492e236" data-title="Available Version">68.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d141492e224" data-title="Name"><samp class="codeph nolang">lossReserveAmount</samp></td>

                <td class="entry" headers="d141492e227" data-title="Type">Double</td>

                <td class="entry" headers="d141492e230" data-title="Description">Amount that's reserved to cover a potential payment for a loss.</td>

                <td class="entry" headers="d141492e233" data-title="Required or Optional">Optional</td>

                <td class="entry" headers="d141492e236" data-title="Available Version">68.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d141492e224" data-title="Name"><samp class="codeph nolang">lossType</samp></td>

                <td class="entry" headers="d141492e227" data-title="Type">String</td>

                <td class="entry" headers="d141492e230" data-title="Description">Type of the loss for which the claim is initiated.</td>

                <td class="entry" headers="d141492e233" data-title="Required or Optional">Optional</td>

                <td class="entry" headers="d141492e236" data-title="Available Version">65.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d141492e224" data-title="Name"><samp class="codeph nolang">name</samp></td>

                <td class="entry" headers="d141492e227" data-title="Type">String</td>

                <td class="entry" headers="d141492e230" data-title="Description">Name of the claim.</td>

                <td class="entry" headers="d141492e233" data-title="Required or Optional">Optional</td>

                <td class="entry" headers="d141492e236" data-title="Available Version">65.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d141492e224" data-title="Name"><samp class="codeph nolang">options</samp></td>

                <td class="entry" headers="d141492e227" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_claim_options_input.htm" title="Input representation for claim options.">Claim Options Input</a></td>

                <td class="entry" headers="d141492e230" data-title="Description">Options for creating or updating a claim.</td>

                <td class="entry" headers="d141492e233" data-title="Required or Optional">Optional</td>

                <td class="entry" headers="d141492e236" data-title="Available Version">65.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d141492e224" data-title="Name"><samp class="codeph nolang">participants</samp></td>

                <td class="entry" headers="d141492e227" data-title="Type">
                  <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_claim_participant_input.htm" title="Input representation for a claim participant.">Claim Participant Input[]</a>
                </td>

                <td class="entry" headers="d141492e230" data-title="Description">Claim participants that are associated with the claim.</td>

                <td class="entry" headers="d141492e233" data-title="Required or Optional">Optional</td>

                <td class="entry" headers="d141492e236" data-title="Available Version">65.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d141492e224" data-title="Name"><samp class="codeph nolang">productCode</samp></td>

                <td class="entry" headers="d141492e227" data-title="Type">String</td>

                <td class="entry" headers="d141492e230" data-title="Description">Product code of the claim product.</td>

                <td class="entry" headers="d141492e233" data-title="Required or Optional">Required to create a claim</td>

                <td class="entry" headers="d141492e236" data-title="Available Version">65.0</td>

              </tr>

            </tbody>

          </table>

## Response Body for PATCH

[Claim Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_create_claim_output.htm "Output representation for a created or updated claim.")