Update Proposal's Domain Coverage by Coverage Category

patch

https://{environment}.origamirisk.com/OrigamiApi/api/Quotes/Proposals/{proposalId}/Coverages/{domain}/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Overview

Updates an existing coverage record within a proposal. Send a JSON object containing only the fields you want to change. 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: Update a coverage limit:

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

{
  "Limit": 250000.00,
  "Deductible": 1000.00
}

200 OK
{
  "IsSuccessful": true,
  "RecordID": 501,
  "Message": "Updated coverage with id 501 successfully."
}

Scenario 2: Validation error on a required field:

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

{
  "Limit": null
}

200 OK
{
  "IsSuccessful": false,
  "RecordID": 0,
  "Message": "Limit is required.",
  "Details": [
    {
      "Field": "Limit",
      "FriendlyFieldName": "Coverage Limit",
      "Message": "Limit is required."
    }
  ]
}

Path Params

proposalId

integer

required

The ID of the Proposal you are updating.

domain

string

required

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

integer

required

The ID of the coverage record (ie, if my {domain} is Claim then this ID is the ClaimID).

Body Params

RAW_BODY

json

required

Defaults to {"Field1": "Value 1","Field2": "Value 2"}

A JSON object with key-value pairs for the fields to update. The keys must correspond to fields defined in the coverage domain's data dictionary (e.g., for ProposalCLCoverage: Limit, Deductible, Premium, etc.). Keys must be exact property names (case-sensitive). Unknown keys throw an error. Only the fields included are modified; unspecified fields are left unchanged.

Use GET .../Coverages/{domain}/{id} to see the full set of fields and their current values for an existing record.

Response