Skip to content

PRE_CANCELLATION_ISSUED

Pre-Cancellation notice has been issued.

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#

HTTPPOST
POST https://api.{ENV}.dais.com/ioi/v3/event/fire
cURL
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_CANCELLATION_ISSUED",
  "payload": {
    "policyId": "<UUID of the policy ID>",
    "clientId": "<UUID of the client ID>",
    "policy": {
      "id": "<UUID of the policy ID>",
      "policyNumber": "<Policy number>",
      "issuingOrganizationId": "<UUID of the issuing organization ID>",
      "sellerOrganizationId": "<UUID of the seller organization ID>",
      "clientId": "<UUID of the client ID>",
      "quoteId": "<UUID of the quote request ID>",
      "productId": "<UUID of the product ID>",
      "premium": 4200.0,
      "effectiveDate": "2026-11-01",
      "expirationDate": "2027-11-01",
      "lastDayWithCoverage": "2027-10-31",
      "asRatingConfiguredAtTimestamp": "2026-10-01T00:00:00Z"
    },
    "event": {
      "type": "PRE_CANCELLATION_NOTICE_SENT",
      "effectiveDate": "2027-04-01",
      "label": "<Label>",
      "eventId": "<UUID of the policy event ID>"
    },
    "documents": [
      {
        "name": "<Document name>",
        "extension": "pdf",
        "contentId": "<UUID of the document content ID>",
        "url": "<Document URL>"
      }
    ]
  }
}'
JSON
{
  "lineId": "<UUID of the product ID>",
  "type": "PRE_CANCELLATION_ISSUED",
  "payload": {
    "policyId": "<UUID of the policy ID>",
    "clientId": "<UUID of the client ID>",
    "policy": {
      "id": "<UUID of the policy ID>",
      "policyNumber": "<Policy number>",
      "issuingOrganizationId": "<UUID of the issuing organization ID>",
      "sellerOrganizationId": "<UUID of the seller organization ID>",
      "clientId": "<UUID of the client ID>",
      "quoteId": "<UUID of the quote request ID>",
      "productId": "<UUID of the product ID>",
      "premium": 4200.0,
      "effectiveDate": "2026-11-01",
      "expirationDate": "2027-11-01",
      "lastDayWithCoverage": "2027-10-31",
      "asRatingConfiguredAtTimestamp": "2026-10-01T00:00:00Z"
    },
    "event": {
      "type": "PRE_CANCELLATION_NOTICE_SENT",
      "effectiveDate": "2027-04-01",
      "label": "<Label>",
      "eventId": "<UUID of the policy event ID>"
    },
    "documents": [
      {
        "name": "<Document name>",
        "extension": "pdf",
        "contentId": "<UUID of the document content ID>",
        "url": "<Document URL>"
      }
    ]
  }
}

Request Fields#

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

Payload Fields#

PropertyRequiredDescription
policyIdYesPolicy identifier tied to the pre-cancellation.
clientIdNoClient identifier associated with the policy.
documents[]NoAny documents associated with the event (e.g., notice PDF).
eventNoRepresentation of the PRE_CANCELLATION_NOTICE_SENT policy event.
policyNoPolicy snapshot at the time of activation. Use the same policy as policyId.

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.

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

Response Fields#

PropertyDescription
triggerRequestIdUUID identifying this trigger execution.
executedActionCountNumber of actions reported as executed.
expectedResponseCountNumber of expected action responses.
metadataAction-specific results; may be empty.

See Firing an Event for execution modes and response handling.