Claim (GET, PATCH)

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

Resource

{claimId} is a placeholder.

1/connect/claims/{claimId}

Resource Example

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

1https://{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

Request Body for PATCH

JSON Example

1{
2  "name": "Claim for Auto Accident",
3  "lossDate": "2025-10-23T15:41:10.446Z",
4  "claimLossDate": "2025-09-15",
5  "claimType": "Auto",
6  "claimReason": "Rear-end collision",
7  "claimReasonType": "Accident",
8  "lossType": "Accident",
9  "insurancePolicyId": "0YTx0000000001qEAA",
10  "productCode": "AutoClaimRoot",
11  "accountId": "001xx000003DGQyAAO",
12  "expenseReserveAmount": 750.50,
13  "expenseReserveAdjustmentReason": "Initial expense reserve",
14  "lossReserveAmount": 5000.00,
15  "lossReserveAdjustmentReason": "Initial loss reserve",
16  "additionalFields": {
17    "PoliceReportNumber": "SF2025-00817",
18    "IsTotalLoss": false,
19    "ReportedDate__c": "2025-09-15"
20  },
21  "options": {
22    "executeConfigurationRules": "false"
23  },
24  "attributes": {
25    "list": [
26      {
27        "apiName": "WeatherConditions",
28        "value": "Clear and Sunny"
29      },
30      {
31        "apiName": "NumberOfVehicles",
32        "value": "2"
33      }
34    ]
35  },
36  "items": {
37    "list": [
38      {
39        "instanceKey": "item_vehicle_damage_01",
40        "name": "Damaged Rear Bumper and Trunk",
41        "productCode": "AUTO-SEDAN-2023",
42        "category": "Auto Physical Damage",
43        "insuredItemId": "02ixx0000004l5sAAA",
44        "insurancePolicyCoverageId": "0cvxx000000AbCdEfG",
45        "attributes": {
46          "list": [
47            {
48              "apiName": "DamageSeverity",
49              "value": "Moderate"
50            }
51          ]
52        },
53        "additionalFields": {
54          "RepairEstimate": 2750,
55          "Date_Damage_First_Noticed__c": "2025-09-15"
56        },
57        "relatedObjects": {
58          "list": [
59            {
60              "relatedRecordId": "001xx000003DGQzAAP",
61              "relatedRecordObjName": "Account"
62            }
63          ]
64        },
65        "participantInstanceKey": "participant_driver_01",
66        "action": "update"
67      }
68    ]
69  },
70  "participants": {
71    "list": [
72      {
73        "instanceKey": "participant_driver_01",
74        "contactId": "003xx000003DGQyAAO",
75        "accountId": "001xx000003DGQyAAO",
76        "insurancePolicyParticipantId": "0pPxx000000001qEAA",
77        "isInjured": false,
78        "roles": [
79          "Driver",
80          "Claimant"
81        ],
82        "additionalFields": {
83          "StatementTaken": true
84        },
85        "action": "update"
86      }
87    ]
88  }
89}

Properties

Name	Type	Description	Required or Optional	Available Version
`accountId`	String	ID of the account that’s associated with the claim.	Optional	65.0
`additionalFields`	Object	Additional standard or custom fields that are used to create or update insurance claim.	Optional	65.0
`attributes`	Claim Attribute Input[]	Attributes of the claim product.	Optional	65.0
`claimLossDate`	String	Date when the loss occurred. This parameter doesn’t accept time of incident. To specify both the date and time of loss, use the `lossDate` parameter.	Optional	66.0
`claimReason`	String	Reason for the claim.	Optional	65.0
`claimReasonType`	String	Category that the claim reason belongs to.	Optional	65.0
`claimType`	String	Type of claim.	Optional	65.0
`expenseReserveAdjustmentReason`	String	Reason for the expense reserve adjustment.	Optional	68.0
`expenseReserveAmount`	Double	Amount that’s reserved to cover potential expenses while handling the claim, such as administrative or legal costs.	Optional	68.0
`insurancePolicyId`	String	ID of the insurance policy on which the claim is raised.	Optional	65.0
`items`	Claim Item Input[]	Details of the items that are associated with the claim.	Optional	65.0
`lossDate`	Date	Date and time when the loss occurred. 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 `claimLossDate` parameter.	Optional	65.0
`lossReserveAdjustmentReason`	String	Reason for the loss reserve adjustment.	Optional	68.0
`lossReserveAmount`	Double	Amount that’s reserved to cover a potential payment for a loss.	Optional	68.0
`lossType`	String	Type of the loss for which the claim is initiated.	Optional	65.0
`name`	String	Name of the claim.	Optional	65.0
`options`	Claim Options Input	Options for creating or updating a claim.	Optional	65.0
`participants`	Claim Participant Input[]	Claim participants that are associated with the claim.	Optional	65.0
`productCode`	String	Product code of the claim product.	Required to create a claim	65.0

Response Body for PATCH

Claim Response