POST v1/PolicyActions/{policyId}/IntentToCancel

Record an intent to cancel against an existing policy. The policy must be active or expired; pending, cancelled, voided and deleted policies are rejected.

Request Information

URI Parameters

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

Body Parameters

Details of the intent to cancel. CancellationReasonID, IntentToCancelDate and StatusID are required. Optionally carries CreatedBy, the employee the intent is recorded on behalf of (active and in one of the caller's offices); when omitted the authenticated user is used.

IntentToCancelActionDTO

Name	Description	Type	Additional information
CancellationReasonID	Required. Id of the cancellation reason. Valid values come from the policy cancellation reasons list.	integer	None.
Description	Free form description of the intent to cancel	string	None.
IntentToCancelDate	Required. Date the intent to cancel takes effect	date	None.
StatusID	Required. Id of the intent-to-cancel workflow status. Valid values are returned by GET v1/Locations/{locationID}/Policies/IntentToCancelStatuses. Every office is seeded with three defaults: "Cancelled", "Carrier Declined" and "Waiting on Customer"; agencies may configure additional statuses.	integer	None.
CreatedBy	Optional. Id of the QQ employee the intent to cancel is recorded on behalf of. Must be an active employee in one of the caller's offices. Recorded as the CSR and on the activity; when omitted the authenticated user is used.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CancellationReasonID": 1,
  "Description": "sample string 1",
  "IntentToCancelDate": "2026-10-30T09:37:56.10395+00:00",
  "StatusID": 1,
  "CreatedBy": 1
}

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:

<IntentToCancelActionDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies">
  <CancellationReasonID>1</CancellationReasonID>
  <CreatedBy>1</CreatedBy>
  <Description>sample string 1</Description>
  <IntentToCancelDate>2026-10-30T09:37:56.10395+00:00</IntentToCancelDate>
  <StatusID>1</StatusID>
</IntentToCancelActionDTO>

Response Information

Resource Description

Action result indicating whether the intent to cancel was recorded

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>