Policy Holds
Overview
Policy Holds are available to prevent the user or system from initiating or continuing transaction processes that should not be made for certain policies in the system. These are implemented using Entity Hold objects. These are created and managed as needed to reflect the onset and eventual conclusion of any desired hold states.
Lifecycle
The lifecycle of a hold looks like this:

Policy Holds can be created in draft
state and then validated
, but won’t have an effect until you explicitly activate them.
When a hold should no longer be in effect, you can explicitly release or discard it.
Policy & Quote Holds
When a hold exists for a given policy, any transactions listed either by category in the transactionCategory
array or explicitly by name in the transactionType
array of the PolicyHoldScope of the CreateEntityHoldRequest, will be prevented for being created for that policy. This will remain the case until the hold is released.
A hold can also be applied to non-issed quotes, preventing the user from progressing the quote beyond the specified quote state. When applied to an existing quote alredy in the specified state, further progression will be blocked.
Auto-Renewal Holds
A hold can also be applied to prevent the auto-renewal process from initiating for the given policy. This is done by setting the autoRenewalHold
property on the PolicyHoldScope to true
. When this hold is active, no auto-renewal will be created for the policy, and any existing auto-renewals will be gated from progressing in their lifecycle.