Insurance Contract Endorse Input

Input representation of the details, such as quote ID, endorsement effective date, optional enrollment window, and additional fields to create an endorsed contract version from a quote.

JSON Example

{
  "quoteId": "0Q0xx0000004CtoCAE",
  "effectiveDate": "2026-02-01",
  "updateExistingContractDates": false,
  "additionalFields": {
    "insuranceContractItemList": [
      {
        "entity": "Contract",
        "fields": {
          "data": [
            {
              "key": "Description",
              "value": "Renewed for FY2026"
            }
          ]
        }
      },
      {
        "entity": "InsuranceContract",
        "fields": {
          "data": [
            {
              "key": "myCustomPickList__c",
              "value": "Alive"
            },
            {
              "key": "EnrollmentEndDate",
              "value": "2022-01-20"
            },
            {
              "key": "EnrollmentStartDate",
              "value": "2021-01-20"
            }
          ]
        }
      },
      {
        "entity": "ContractGroupPlan",
        "productPath": "dentalBasic",
        "fields": {
          "data": [
            {
              "key": "EnrollmentEndDate",
              "value": "2025-12-31"
            }
          ]
        }
      }
    ]
  }
}

Properties

Name	Type	Description	Required or Optional	Available Version
`additionalFields`	Insurance Contract Item Input[]	List of additional fields to add to contract items.	Optional	68.0
`effectiveDate`	String	Effective date of endorsement that indicates the start date of the endorsed contract. Specify the date in the yyyy-MM-dd format.	Required	68.0
`quoteId`	String	ID of the quote for contract endorsement.	Required	68.0
`updateExistingContractDates`	Boolean	Indicates whether to update dates on the existing contract when creating the endorsed contract version (`true`) or not (`false`).	Optional	68.0