CANCEL_RENEWAL

Cancel policy renewal

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": "CANCEL_RENEWAL",
  "payload": {
    "policyId": "<UUID of the policy ID>",
    "clientId": "<UUID of the client ID>",
    "quoteId": "<UUID of the quote request ID>",
    "configId": "<UUID of the configuration ID>",
    "label": "<Label>",
    "documents": [],
    "backofficeIntake": {
      "cancelReason": {
        "type": "ANSWER",
        "answer": "<Answer for this question>"
      },
      "cancellationDate": {
        "type": "ANSWER",
        "answer": "2026-12-01"
      }
    }
  }
}'

{
  "lineId": "<UUID of the product ID>",
  "type": "CANCEL_RENEWAL",
  "payload": {
    "policyId": "<UUID of the policy ID>",
    "clientId": "<UUID of the client ID>",
    "quoteId": "<UUID of the quote request ID>",
    "configId": "<UUID of the configuration ID>",
    "label": "<Label>",
    "documents": [],
    "backofficeIntake": {
      "cancelReason": {
        "type": "ANSWER",
        "answer": "<Answer for this question>"
      },
      "cancellationDate": {
        "type": "ANSWER",
        "answer": "2026-12-01"
      }
    }
  }
}

Request Fields#

See the shared event envelope. Set type to CANCEL_RENEWAL 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
`policyId`	Yes	UUID of the policy whose renewal is being cancelled.
`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`.
`configId`	Yes	UUID of the cancellation configuration that defines which actions to trigger.
`label`	No	Human-readable description of the cancellation.
`documents`	No	List of documents related to the event.
`backofficeIntake`	No	Map of question IDs to answers for backoffice-configured intake fields.

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.