Create Claim Action

Create a claim.

This action is available in API version 65.0 and later.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/createClaim

Where XX.X is the latest API version.

Formats: JSON

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

Input	Type	Description
`createClaimInputRepresentation`	Apex-defined	Required. An Apex ConnectApi.CreateClaimInputRepresentation record that contains the details of the claim to be created.

Outputs

Output	Type	Description
`claimId`	string	ID of the claim that’s created.

Example

Sample Request

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

Sample Response

1[
2  {
3    "actionName": "createClaim",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "claimId": "0Z1S70000004oVfIAI"
10    },
11    "sortOrder": -1,
12    "version": 1
13  }
14]