Update Proposal Coverage

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

Overview

This endpoint updates an existing ProposalCoverage record. The request body fields are applied to the ProposalCoverage entity identified by proposalCoverageId, not to the Proposal itself. This is a true patch update: only provided fields are modified. All others remain unchanged.

For endorsement proposals, the system compares the coverage's field values before and after the update, then records only the fields that actually changed as individual policy change entries. These policy change records are what drive the endorsement's "what changed" summary when the endorsement is later bound.

For non-endorsement proposals (quotes, applications), the changes are saved directly and any configured Data Entry Events (DEEs) for the ProposalCoverage domain are triggered.

After the update, the proposal's modified timestamp is updated.

About the route: The /Schedules/ segment in the path is a historical artifact. Origami uses a generic "schedules" infrastructure for child records of a proposal (locations, vehicles, coverages, etc.), and the PATCH endpoint was built on that generic route pattern (/Schedules/{domain}/{id}). The other ProposalCoverage endpoints (GET, POST, DELETE) were given dedicated /ProposalCoverage/ routes, but the PATCH was not migrated to match.

Preconditions

  • The proposal must be in a modifiable state. A proposal is not modifiable when:

    • Its status is Bound (B), Rejected (R), or Unapplied (0)
    • The proposal set it belongs to is already bound
    • It has a pending expiry date change endorsement

    If not modifiable, the endpoint returns a failure response.

  • The proposalCoverageId must belong to the specified proposalId.

Path Params
integer
required

The ID of the Proposal that is being updated.

integer
required

The ID of the schedule record that is being updated. The proposalCoverageId must belong to the specified proposalId

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

The is a simple JSON object representing the name-value pairs for the fields in the record you are updating. Fields are case sensitive.
ex: {"Field1": "Value 1","Field2": "Value 2","Field 3": "Value 3"}

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