Claim (GET, PATCH)

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

Resource

1/connect/claims/claimId

Resource example

1https://yourInstance.salesforce.com/services/data/v67.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  "additionalFields": {
13    "PoliceReportNumber": "SF2025-00817",
14    "IsTotalLoss": false,
15    "ReportedDate__c": "2025-09-15"
16  },
17  "options": {
18    "executeConfigurationRules": "false"
19  },
20  "attributes": {
21    "list": [
22      {
23        "apiName": "WeatherConditions",
24        "value": "Clear and Sunny"
25      },
26      {
27        "apiName": "NumberOfVehicles",
28        "value": "2"
29      }
30    ]
31  },
32  "items": {
33    "list": [
34      {
35        "instanceKey": "item_vehicle_damage_01",
36        "name": "Damaged Rear Bumper and Trunk",
37        "productCode": "AUTO-SEDAN-2023",
38        "category": "Auto Physical Damage",
39        "insuredItemId": "02ixx0000004l5sAAA",
40        "insurancePolicyCoverageId": "0cvxx000000AbCdEfG",
41        "attributes": {
42          "list": [
43            {
44              "apiName": "DamageSeverity",
45              "value": "Moderate"
46            }
47          ]
48        },
49        "additionalFields": {
50          "RepairEstimate": 2750,
51          "Date_Damage_First_Noticed__c": "2025-09-15"
52        },
53        "relatedObjects": {
54          "list": [
55            {
56              "relatedRecordId": "001xx000003DGQzAAP",
57              "relatedRecordObjName": "Account"
58            }
59          ]
60        },
61        "participantInstanceKey": "participant_driver_01",
62        "action": "update"
63      }
64    ]
65  },
66  "participants": {
67    "list": [
68      {
69        "instanceKey": "participant_driver_01",
70        "contactId": "003xx000003DGQyAAO",
71        "accountId": "001xx000003DGQyAAO",
72        "insurancePolicyParticipantId": "0pPxx000000001qEAA",
73        "isInjured": false,
74        "roles": [
75          "Driver",
76          "Claimant"
77        ],
78        "additionalFields": {
79          "StatementTaken": true
80        },
81        "action": "update"
82      }
83    ]
84  }
85}

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
`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
`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

Insurance Developer Guide

Claim (GET, PATCH)