POST v1/PolicyActions/{policyId}/Cancel

Cancel an existing policy. The policy must be active or expired; pending, cancelled, voided and deleted policies are rejected. Creates the cancellation; updating an existing cancellation is not supported. Any intent to cancel recorded before the cancellation date is removed.

Request Information

URI Parameters

Name	Description	Type	Additional information
policyId	Required. Id of the policy to cancel	string	Required

Body Parameters

Details of the cancellation. CancellationDate is required and must fall within the policy term, inclusive of the effective and expiration dates. RequestedByID, PolicyReleaseObtainedID and MethodID must carry one of their documented codes when supplied. The CSR and the originating application code are taken from the authenticated user.

CancelPolicyActionDTO

Name	Description	Type	Additional information
CancellationDate	Required. Date the cancellation takes effect. Also used as the adjustment date.	date	None.
CancellationReasonID	Id of the cancellation reason. Valid values are returned by GET v1/Locations/{locationID}/Policies/CancellationReasons.	integer	None.
CancellationDescription	Free form description of the cancellation. Stored as the adjustment remarks and included in the activity note generated for the cancellation.	string	None.
RequestedByID	Who requested the cancellation. Valid values are "A" (Agent), "C" (Company), "I" (Insured) and "O" (Other).	string	None.
PolicyReleaseObtainedID	Whether the policy release was obtained. Valid values are "N" (Not Obtained), "P" (Policy Obtained) and "R" (Release Statement Obtained).	string	None.
MethodID	How the unearned amounts were calculated. Valid values are "F" (Flat), "P" (Pro Rata) and "S" (Short).	string	None.
SubjecttoAudit	Whether the cancelled policy is subject to audit.	boolean	None.
OtherLabel	Free form label used when RequestedByID is "O" (Other). Limited to 50 characters.	string	None.
PremiumChange	Premium amount to reverse off the policy. This is the unearned premium expressed as a negative amount: the UI sends -PremiumUnearned. Defaults to 0 when omitted.	decimal number	None.
CommissionChange	Commission amount to reverse off the policy. This is the unearned commission expressed as a negative amount: the UI sends -CommissionUnearned. Defaults to 0 when omitted.	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "CancellationDate": "2026-09-19T08:21:06.7602122+00:00",
  "CancellationReasonID": 1,
  "CancellationDescription": "sample string 1",
  "RequestedByID": "sample string 2",
  "PolicyReleaseObtainedID": "sample string 3",
  "MethodID": "sample string 4",
  "SubjecttoAudit": true,
  "OtherLabel": "sample string 5",
  "PremiumChange": 1.0,
  "CommissionChange": 1.0
}

application/x-www-form-urlencoded

Sample:

Form URL encoded content is supported for requests. The form keys are the property names shown in the JSON sample, nested as Property.Child and Collection[0].Property.

application/xml, text/xml

Sample:

<CancelPolicyActionDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies">
  <CancellationDate>2026-09-19T08:21:06.7602122+00:00</CancellationDate>
  <CancellationDescription>sample string 1</CancellationDescription>
  <CancellationReasonID>1</CancellationReasonID>
  <CommissionChange>1</CommissionChange>
  <MethodID>sample string 4</MethodID>
  <OtherLabel>sample string 5</OtherLabel>
  <PolicyReleaseObtainedID>sample string 3</PolicyReleaseObtainedID>
  <PremiumChange>1</PremiumChange>
  <RequestedByID>sample string 2</RequestedByID>
  <SubjecttoAudit>true</SubjecttoAudit>
</CancelPolicyActionDTO>

Response Information

Resource Description

Action result indicating whether the policy was cancelled

ActionResultDTO

Name	Description	Type	Additional information
IsSuccess	Signifies whether action is successful	boolean	None.
ErrorCode	Error code	string	None.
ErrorMessage	Error message	string	None.
InfoMessage	Information message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "ErrorCode": "sample string 2",
  "ErrorMessage": "sample string 3",
  "InfoMessage": "sample string 4"
}

application/xml, text/xml

Sample:

<ActionResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <ErrorCode>sample string 2</ErrorCode>
  <ErrorMessage>sample string 3</ErrorMessage>
  <InfoMessage>sample string 4</InfoMessage>
  <IsSuccess>true</IsSuccess>
</ActionResultDTO>