Queue Asynchronous Binding of a Proposal into an Active Policy

post

https://{environment}.origamirisk.com/OrigamiApi/api/Quotes/Proposals/{proposalId}/QueueBindQuote

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Overview

Queues a proposal for asynchronous binding. Instead of binding synchronously and waiting for the result, this endpoint places the bind operation into a background processing queue and returns immediately. Use GET /api/Quotes/Proposals/{proposalId}/BindStatus to poll for completion.

Examples

Scenario 1: Queue a new quote for binding with annual billing:

POST /api/Quotes/Proposals/12345/QueueBindQuote?billingFrequencyCode=A

200 OK (no response body)

Scenario 2: Queue an endorsement for binding with "next bill" status:

POST /api/Quotes/Proposals/12345/QueueBindQuote?billingStatus=N

200 OK (no response body)

Path Params

proposalId

integer

required

The ID of the Proposal that you are binding.

Query Params

billingFrequencyCode

string

For new quotes only: The billing frequency code for the desired payment schedule. Retrieve valid codes from GET /api/Quotes/Proposals/{proposalId}/BillingOptions (use the BillingFrequencyCode field from the response). If omitted, the proposal's existing billing frequency is used. Ignored for endorsements.

billingStatus

string

enum

For endorsements only: Controls how the premium adjustment is billed. See valid codes below. Not used for new quotes.

Code	Name	Description
`"B"`	Billed	Generates a new invoice immediately. For credits-only endorsements, applies credits to existing invoices instead.
`"W"`	Waived	Creates an invoice record but waives collection; no payment is due.
`"N"`	Next Bill	Adds the amount to the next pending invoice on the policy. Requires at least one pending invoice.
`"S"`	Distributed (Spread)	Distributes the amount across all remaining pending invoices on the policy. Requires at least one pending invoice.
`"E"`	Earned Premium Billed	Prorates the premium change across remaining pending invoices based on earned premium billing periods. Requires earned premium billing to be enabled on the billing profile.

Allowed:

Response

200