v3

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-10184967.1 KB

Amendment

Cancel a policy

Cancels an existing policy

delete/v1/amendment/cancel

Headers

Authorizationstring

Bearer token

Request body

policyCodestring required

The policy code to cancel

reasonstring required

The reason for cancellation

Example request

{
  "policyCode": "POLICY-123456",
  "reason": "Customer requested cancellation"
}

Response

The policy has been successfully cancelled.

policyCodestring required

The policy code that was cancelled

status'active' | 'canceled' required

The status of the policy after cancellation

cancelReasonstring required

The reason for cancellation

cancelledAtstring date-time required

The date and time when the policy was cancelled

Example response

{
  "policyCode": "POLICY-123456",
  "status": "canceled",
  "cancelReason": "Customer requested cancellation",
  "cancelledAt": "2023-01-01T12:00:00Z"
}