Skip to content

VOID_CANCEL_RENEWAL

This event is fired when voiding a previously cancelled policy renewal. It triggers the VOID_CANCEL_RENEWAL action, which restores or reactivates a renewal that had been cancelled earlier. This event is useful for administrative corrections or to reverse cancellations that were made in error.

When and what fires this event?

If this event is defined on a policy, and the associated actions are enabled:

  • Policy Administration: fires this event when a cancelled renewal is manually restored;
  • External systems: may fire this event via API to reverse a cancellation;
  • Automated workflows: may trigger it as part of a reinstatement or policy recovery process.

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 '{
  "lineId": "<UUID of the product or policy>",
  "type": "VOID_CANCEL_RENEWAL",
  "payload": {
      "policyId": "<UUID of the policy>",
      "renewalId": "<UUID of the previously cancelled renewal>",
      "reason": "Reinstated due to client request",
      "requestedBy": "admin@example.com",
      "asConfiguredAtTimestamp": "2025-10-28T12:00:00Z"
  }
}'
{
  "lineId": "f12e67be-c08c-43c0-bb51-06fe4408b4e9",
  "type": "VOID_CANCEL_RENEWAL",
  "payload": {
      "policyId": "a01b1f20-7f20-4a16-ba51-d0945804dd83",
      "renewalId": "b20c4020-9a30-4a16-ba51-d0945804aa11",
      "reason": "Reinstated due to client request",
      "requestedBy": "admin@example.com",
      "asConfiguredAtTimestamp": "2025-10-28T12:00:00Z"
  }
}

Request fields

PropertyRequiredDescription
lineIdtrueUUID for the product or policy line.
typetrueMust be set to VOID_CANCEL_RENEWAL.
payloadtrueExplained below.

Payload fields

PropertyRequiredDescription
policyIdtrueUUID for the policy whose renewal cancellation is being voided.
renewalIdfalseUUID of the cancelled renewal being reinstated.
reasonfalseText describing why the cancellation is being voided.
requestedByfalseIdentifier (email, userId, etc.) of the user or system initiating the void action.
asConfiguredAtTimestampfalseTimestamp for when the configuration or renewal state was last updated.

Response json

{
  "triggerRequestId": "dd55a520-5194-4b6f-b84d-3457f189c5cf",
  "executedActionCount": 1,
  "expectedResponseCount": 1,
  "metadata": {
    "VOID_CANCEL_RENEWAL": {
      "policyId": "a01b1f20-7f20-4a16-ba51-d0945804dd83",
      "renewalId": "b20c4020-9a30-4a16-ba51-d0945804aa11",
      "status": "VOIDED_CANCELLATION",
      "voidedAt": "2025-10-28T12:00:02Z",
      "reason": "Reinstated due to client request"
    }
  }
}

Response fields

PropertyRequiredDescription
triggerRequestIdtrueUUID that identifies the execution of the trigger.
executedActionCounttrueNumber of actions executed by this trigger.
expectedResponseCounttrueNumber of responses expected from the executed actions.
metadatatrueContains dynamically generated data from workflow actions.