PRE_POLICY_CANCELLATION

Before a policy is cancelled, this event may be called any number of times.

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": "PRE_POLICY_CANCELLATION",
  "payload": {
    "clientId": "<UUID of the client ID>",
    "quoteId": "<UUID of the quote request ID>",
    "policyId": "<UUID of the policy ID>",
    "documents": [],
    "cancellationReasonConfigId": "<UUID of the cancellation reason configuration ID>",
    "effectiveDate": "2026-04-01",
    "label": "<Label>",
    "backofficeIntake": {
      "cancellationReason": {
        "type": "ANSWER",
        "answer": "<Answer for this question>"
      },
      "noticeDate": {
        "type": "ANSWER",
        "answer": "2026-03-01"
      }
    }
  }
}'

{
  "lineId": "<UUID of the product ID>",
  "type": "PRE_POLICY_CANCELLATION",
  "payload": {
    "clientId": "<UUID of the client ID>",
    "quoteId": "<UUID of the quote request ID>",
    "policyId": "<UUID of the policy ID>",
    "documents": [],
    "cancellationReasonConfigId": "<UUID of the cancellation reason configuration ID>",
    "effectiveDate": "2026-04-01",
    "label": "<Label>",
    "backofficeIntake": {
      "cancellationReason": {
        "type": "ANSWER",
        "answer": "<Answer for this question>"
      },
      "noticeDate": {
        "type": "ANSWER",
        "answer": "2026-03-01"
      }
    }
  }
}

Request Fields#

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

Payload Fields#

Required fields include the inputs used by this event's built-in action. Configured actions can require additional data.

Property	Required	Description
`clientId`	No	UUID of the client who owns the policy identified by `policyId`.
`quoteId`	No	UUID of the original quote associated with the policy identified by `policyId`.
`policyId`	Yes	UUID of the policy.
`documents`	No	List of documents related to the event.
`cancellationReasonConfigId`	Yes	UUID of the cancellation reason configuration.
`effectiveDate`	Yes	Effective date of the pre-cancellation notice (format: `YYYY-MM-DD`).
`label`	No	Optional label for the cancellation.
`backofficeIntake`	No	Map of backoffice form fields to values.

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.