CANCEL_RENEWAL

This event is fired when cancelling a policy renewal. It triggers the CANCEL_RENEWAL action, which invalidates or reverses a previously generated renewal for a given policy.

When and what fires this event?

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

Copilot: fires when a renewal is cancelled;
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 '{
  "lineId": "<UUID of the product or policy>",
  "type": "CANCEL_RENEWAL",
  "payload": {
      "policyId": "<UUID of the policy>",
      "renewalId": "<UUID of the renewal to be cancelled>",
      "reason": "Client requested cancellation",
      "requestedBy": "agent@example.com",
      "asConfiguredAtTimestamp": "2025-10-28T12:00:00Z"
  }
}'

{
  "lineId": "f12e67be-c08c-43c0-bb51-06fe4408b4e9",
  "type": "CANCEL_RENEWAL",
  "payload": {
      "policyId": "a01b1f20-7f20-4a16-ba51-d0945804dd83",
      "renewalId": "b20c4020-9a30-4a16-ba51-d0945804aa11",
      "reason": "Client requested cancellation",
      "requestedBy": "agent@example.com",
      "asConfiguredAtTimestamp": "2025-10-28T12:00:00Z"
  }
}

Request fields

Property	Required	Description
`lineId`	`true`	UUID for the product or policy line.
`type`	`true`	Must be set to `CANCEL_RENEWAL`.
`payload`	`true`	Explained below.

Payload fields

Property	Required	Type	Description
`policyId`	true	UUID	Unique identifier of the policy whose renewal is being cancelled.
`renewalId`	true	UUID	Identifier of the renewal instance to be cancelled.
`reason`	false	String	Optional reason explaining the cancellation.
`requestedBy`	false	String	Email or identifier of the user/system requesting the cancellation.
`asConfiguredAtTimestamp`	false	String	Timestamp for config versioning used to process the cancellation.

Response json

{
  "lineId": "262e67be-c08c-43c0-bb51-06fe4408b4e9",
  "type": "CANCEL_RENEWAL",
  "payload": {
    "policyId": "b6a8b2a4-53fd-4b5b-a1c1-9c81378a6e52",
    "configId": "a94d1e6b-3c77-4c60-bb32-5e1b36e0533e",
    "label": "Cancelled due to client request",
    "backofficeIntake": {
      "cancelReason": "Client switched carrier",
      "notifiedBy": "Agent"
    }
  }
}

Response fields

This payload represents the event data returned after firing the CANCEL_RENEWAL trigger.

Property	Required	Description
`lineId`	`true`	UUID of the product line associated with this event.
`type`	`true`	Trigger type executed.
`payload`	`true`	Contains additional data used by the event handler.

Payload fields

These fields belong to the object under payload.

Property	Required	Description
`policyId`	`true`	UUID of the policy being cancelled for renewal.
`configId`	`true`	UUID referencing the configuration associated with the cancellation.
`label`	`false`	Description of the cancellation reason.
`backofficeIntake`	`false`	Object containing cancellation details.

Backoffice Intake fields

Each field represents additional structured information submitted by backoffice users.

Property	Required	Description
`cancelReason`	`false`	Reason provided for the renewal cancellation.
`notifiedBy`	`false`	Who notified or initiated the cancellation.