Claim (POST)

Create a claim.

Resource

1/connect/claims

Resource example

1https://yourInstance.salesforce.com/services/data/v65.0/connect/claims

Available version

65.0

HTTP methods

POST

Request body for POST

JSON example

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

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
`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
`incidentTypeId`	String	ID for the type of incident in the 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 on which the loss occurred.	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 POST

Claim Response

Insurance Developer Guide

Claim (POST)