Skip to main content
POST
/
submission
/
{displayId}
/
cancel-request
Request Cancellation
curl --request POST \
  --url https://api.coverwhale.dev/v1/submission/{displayId}/cancel-request \
  --header 'AccessToken: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "effective_date_transaction": "03/01/2026",
  "effective_date_transaction_al": "03/01/2026"
}
'
{
  "status": "success",
  "submission_number": "<string>",
  "transaction_id": 123,
  "cancellation_status": "<string>"
}

Authorizations

​
AccessToken
string
header
required

AWS Cognito access token obtained from the /authentication endpoint. Token expires after 3600 seconds.

Headers

​
AccessToken
string
required

Path Parameters

​
displayId
string
required

Submission display ID

Body

application/json
​
effective_date_transaction
string
required

Cancellation effective date (MM/DD/YYYY)

Example:

"03/01/2026"

​
effective_date_transaction_al
string

Optional separate AL cancellation date (MM/DD/YYYY)

Example:

"03/01/2026"

Response

Cancellation request created

​
status
string
Example:

"success"

​
submission_number
string
​
transaction_id
integer
​
cancellation_status
string