Create Claim Action

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

{
  "inputs": [
    {
      "createClaimInputRepresentation": {
        "name": "Claim for Auto Accident",
        "lossDate": "2025-09-15",
        "claimType": "Auto",
        "claimReason": "Rear-end collision",
        "claimReasonType": "Accident",
        "lossType": "Accident",
        "insurancePolicyId": "0YTx0000000001qEAA",
        "accountId": "001xx000003DGQyAAO",
        "expenseReserveAmount": 750.50,
        "expenseReserveAdjustmentReason": "Initial expense reserve",
        "lossReserveAmount": 5000.00,
        "lossReserveAdjustmentReason": "Initial loss reserve",
        "additionalFields": {
          "key": "RepairShop",
          "value": "NY"
        },
        "attributes": [
          {
            "apiName": "WeatherConditions",
            "value": "Clear and Sunny"
          },
          {
            "apiName": "NumberOfVehicles",
            "value": "2"
          }
        ],
        "items": [
          {
            "instanceKey": "item_vehicle_damage_01",
            "name": "Damaged Rear Bumper and Trunk",
            "productCode": "AUTO-SEDAN-2023",
            "category": "Auto Physical Damage",
            "insuredItemId": "02ixx0000004l5sAAA",
            "insurancePolicyCoverageId": "0cvxx000000AbCdEfG",
            "attributes": [
              {
                "apiName": "DamageSeverity",
                "value": "Moderate"
              }
            ],
            "additionalFields": {
              "key": "RepairEstimate",
              "value": 2750
            },
            "relatedObjects": [
              {
                "relatedRecordId": "001xx000003DGQzAAP",
                "relatedRecordObjName": "Account"
              }
            ],
            "participantInstanceKey": "participant_driver_01"
          }
        ],
        "participants": [
          {
            "instanceKey": "participant_driver_01",
            "contactId": "003xx000003DGQyAAO",
            "accountId": "001xx000003DGQyAAO",
            "insurancePolicyParticipantId": "0pPxx000000001qEAA",
            "isInjured": false,
            "roles": [
              "Driver",
              "Claimant"
            ],
            "additionalFields": {
              "StatementTaken": true
            }
          }
        ]
      }
    }
  ]
}

Sample Response

[
  {
    "actionName": "createClaim",
    "errors": null,
    "invocationId": null,
    "isSuccess": true,
    "outcome": null,
    "outputValues": {
      "claimId": "0Z1S70000004oVfIAI"
    },
    "sortOrder": -1,
    "version": 1
  }
]