API Reference

Update a Proposal

patch
https://{environment}.origamirisk.com/OrigamiApi/api/Quotes/Proposals/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Updates specific fields on an existing proposal. Only the fields included in the request body are modified — omitted fields are left unchanged. The request body uses the same Proposal entity schema and property names as creation. The same excluded fields that cannot be set during creation also cannot be set during update.

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 the proposal is not modifiable, the endpoint returns a failure response rather than applying changes.

Path Params
string
required

The ID of the Proposal you are going to update.

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

A JSON object with key-value pairs mapping to Proposal entity fields. The request body schema matches the Proposal data dictionary schema. Keys must be exact property names from the Proposal entity (case-sensitive). Unknown keys throw an error.

You do not need to send the full proposal — only the fields being changed. Fields omitted from the request body retain their current values. Fields you include are overwritten, including required fields like Status or Type.

Response

Updated about 2 months ago

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

Updated about 2 months ago