Add Coverage to Proposal by Category

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Inserts a new coverage record into a proposal for the specified coverage domain. Send a JSON object containing the field values for the new record. The proposal must be in a modifiable state, and the domain must be a valid coverage or subcoverage type for the proposal.

Preconditions

  • The proposal must be modifiable (CanModify is true).
  • The domain must be a valid coverage or subcoverage domain for this proposal.

Examples

Scenario 1: Successfully insert a coverage:

POST /api/Quotes/Proposals/12345/Coverages/ProposalCLCoverage
Content-Type: application/json

{
  "CoverageID": 42,
  "ProposalCLScheduleID": 100,
  "Limit": 100000.00,
  "Deductible": 500.00
}
200 OK
{
  "IsSuccessful": true,
  "RecordID": 501,
  "Message": "Inserted coverage with id 501 successfully.",
  "Warnings": null
}

Scenario 2: Validation error on insert:

POST /api/Quotes/Proposals/12345/Coverages/ProposalCLCoverage
Content-Type: application/json

{
  "ProposalCLScheduleID": 100
}
200 OK
{
  "IsSuccessful": false,
  "RecordID": 0,
  "Message": "CoverageID is required."
}
Path Params
integer
required

The ID of the Proposal you are adding coverage to.

string
required

The name of the Domain object for which you are updating coverages.

Body Params
json
required
Defaults to {"Field1": "Value 1","Field2": "Value 2"}

A JSON object with key-value pairs for the new coverage record. The keys must correspond to fields defined in the coverage domain's data dictionary. Keys must be exact property names (case-sensitive). Unknown keys throw an error.

Required fields depend on the domain's configuration. At minimum, a CoverageID (or SubCoverageID for subcoverage domains) and any required parent foreign keys must be provided.

Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json