POLICY_CREATE

Passive (internal) call to create a new policy.

Submit this event using Firing an Event. Product configuration and enabled actions determine the workflow behavior. Use identifiers and snapshots from the same environment.

Request payload#

POST https://api.{ENV}.dais.com/ioi/v3/event/fire

curl --location --request POST 'https://api.{ENV}.dais.com/ioi/v3/event/fire' \
--header 'Authorization: Basic <Base64-encoded API key and secret>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "lineId": "<UUID of the product ID>",
  "type": "POLICY_CREATE",
  "payload": {
    "clientId": "<UUID of the client ID>",
    "paymentTriggerRequestId": "<UUID of the payment trigger request ID>",
    "paymentRequired": false,
    "quoteIds": [
      "<UUID of the quote request ID>"
    ],
    "paymentPlans": {
      "<UUID of the quote request ID>": "ANNUALLY"
    }
  }
}'

{
  "lineId": "<UUID of the product ID>",
  "type": "POLICY_CREATE",
  "payload": {
    "clientId": "<UUID of the client ID>",
    "paymentTriggerRequestId": "<UUID of the payment trigger request ID>",
    "paymentRequired": false,
    "quoteIds": [
      "<UUID of the quote request ID>"
    ],
    "paymentPlans": {
      "<UUID of the quote request ID>": "ANNUALLY"
    }
  }
}

Request Fields#

See the shared event envelope. Set type to POLICY_CREATE and provide the payload below.

Payload Fields#

Property	Required	Description
`clientId`	Yes	UUID for the client
`paymentTriggerRequestId`	Yes	UUID of the trigger request from the preceding payment event
`paymentRequired`	No	Boolean flag representing whether payment is required before this policy can be issued. Defaults to `true`
`quoteIds`	Conditional	Quote request UUIDs to issue. Supply them when `paymentRequired` is `false`; otherwise the built-in action reads the quote IDs from the preceding payment setup.
`paymentPlans`	No	Map of quoteId to associated payment plan; keys must match the UUIDs in `quoteIds`. Payment plan must be one of: `FULL_PAYMENT`, `MONTHLY`, `BI_ANNUALLY`, `ANNUALLY`, or `FINANCE`

Response#

This example illustrates the common trigger response structure. Action counts and metadata depend on the actions that run; action-specific result fields are described where applicable.

{
  "triggerRequestId": "<UUID of the trigger request ID>",
  "executedActionCount": 0,
  "expectedResponseCount": 0,
  "metadata": {}
}

Response Fields#

Property	Description
`triggerRequestId`	UUID identifying this trigger execution.
`executedActionCount`	Number of actions reported as executed.
`expectedResponseCount`	Number of expected action responses.
`metadata`	Action-specific results; may be empty.

See Firing an Event for execution modes and response handling.