POLICY_CANCEL

This event is fired when a policy is cancelled. It terminates the policy and stops all future coverage and billing.

When and what fires this event?

If this event is defined on a product, and it has actions that are enabled:

Copilot: fires when an administrator cancels a policy manually;
API: can fire this event externally on demand.

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 <yourAuthHere>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "POLICY_CANCEL",
    "payload": {
        "clientId": "<clientId>",
        "policyId": "<policyId>",
        "cancellationReasonConfigId": "<cancellationReasonConfigId>",
        "effectiveDate": "<effectiveDate>",
        "label": "<label>",
        "backofficeIntake": {
            "<qid>": {
                "type": "ANSWER",
                "answer": "<answer>"
            }
        }
    }
}'

{
  "lineId": "262e67be-c08c-43c0-bb51-06fe4408b4e9",
  "type": "POLICY_CANCEL",
  "payload": {
    "clientId": "262e67be-c08c-43c0-bb51-06fe4408b4e9",
    "policyId": "21e398b3-1713-44b7-b044-7328f34efaa3",
    "cancellationReasonConfigId": "c074652b-a9db-4c49-87ee-1bc2404af7a0",
    "effectiveDate": "2020-01-13",
    "label": "label",
    "backofficeIntake": {
      "numEmployees": {
        "type": "ANSWER",
        "answer": "17"
      }
    }
  }
}

Request fields

Type	Required	Description
`lineId`	`true`	UUID for the associated product
`type`	`true`	Must be set to `POLICY_CANCEL`
`payload`	`true`	Explained below

Payload fields

Type	Required	Description
`clientId`	`true`	UUID
`policyId`	`true`	Policy ID
`cancellationReasonConfigId`	`true`	Cancellation reason config ID
`effectiveDate`	`true`	Effective date
`label`	`false`	Label
`backOfficeIntake`	`false`	Map of qid to answer

Response json

{
  "triggerRequestId": "386861af-6875-49b2-b38c-c435263039be",
  "executedActionCount": 0,
  "expectedResponseCount": 0,
  "metadata": {}
}

Response fields

Property	Required	Description
`triggerRequestId`	`true`	UUID that uniquely identifies the trigger execution instance.
`executedActionCount`	`true`	Number of actions executed during this trigger run.
`expectedResponseCount`	`true`	Number of responses expected from the executed actions.
`metadata`	`true`	Contains dynamically generated data from executed workflow actions.