Claim (POST)

Create a claim.

Resource

/connect/claims

Resource Example

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

Available Version

65.0

HTTP Methods

POST

Request Body for POST

JSON Example

{
  "name": "INS-Auto-Claim-27868",
  "lossDate": "2025-10-23T15:41:10.446Z",
  "claimLossDate": "2025-09-15",
  "claimType": "Auto",
  "claimReason": "Rear-end collision",
  "claimReasonType": "Accident",
  "lossType": "Accident",
  "insurancePolicyId": "0YTx0000000001qEAA",
  "productCode": "AutoClaimRoot",
  "accountId": "001xx000003DGQyAAO",
  "expenseReserveAmount": 750.50,
  "expenseReserveAdjustmentReason": "Initial expense reserve",
  "lossReserveAmount": 5000.00,
  "lossReserveAdjustmentReason": "Initial loss reserve",
  "additionalFields": {
    "PoliceReportNumber": "SF2025-00817",
    "IsTotalLoss": false,
    "ReportedDate__c": "2025-09-15"
  },
  "options": {
    "executeConfigurationRules": "false"
  },
  "attributes": {
    "list": [
      {
        "apiName": "WeatherConditions",
        "value": "Clear and Sunny"
      },
      {
        "apiName": "NumberOfVehicles",
        "value": "2"
      }
    ]
  },
  "items": {
    "list": [
      {
        "instanceKey": "item_vehicle_damage_01",
        "name": "Damaged Rear Bumper and Trunk",
        "productCode": "AUTO-SEDAN-2023",
        "category": "Auto Physical Damage",
        "insuredItemId": "02ixx0000004l5sAAA",
        "insurancePolicyCoverageId": "0cvxx000000AbCdEfG",
        "attributes": {
          "list": [
            {
              "apiName": "DamageSeverity",
              "value": "Moderate"
            }
          ]
        },
        "additionalFields": {
          "RepairEstimate": 2750,
          "Date_Damage_First_Noticed__c": "2025-09-15"
        },
        "relatedObjects": {
          "list": [
            {
              "relatedRecordId": "001xx000003DGQzAAP",
              "relatedRecordObjName": "Account"
            }
          ]
        },
        "participantInstanceKey": "participant_driver_01"
      }
    ]
  },
  "participants": {
    "list": [
      {
        "instanceKey": "participant_driver_01",
        "contactId": "003xx000003DGQyAAO",
        "accountId": "001xx000003DGQyAAO",
        "insurancePolicyParticipantId": "0pPxx000000001qEAA",
        "isInjured": false,
        "roles": [
          "Driver",
          "Claimant"
        ],
        "additionalFields": {
          "StatementTaken": true
        }
      }
    ]
  }
}

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 POST

Claim Response