Skip to main content
POST
/
submission
/
{displayId}
/
{transactionId}
/
cancel-approve
Approve Cancellation
curl --request POST \
  --url https://app.coverwhale.com/api/v1/submission/{displayId}/{transactionId}/cancel-approve \
  --header 'AccessToken: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cancellation_reason": [
    "<string>"
  ],
  "internal_cancellation_reason": [
    "<string>"
  ],
  "cancellation_reason_broker": "<string>",
  "cancel_reason_others": "<string>"
}
'
{
  "status": "success",
  "submission_number": "<string>",
  "transaction_id": 123,
  "submission_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
transactionId
integer
required

Body

application/json
cancellation_reason
string[]

Cancellation reason codes

internal_cancellation_reason
string[]

Internal cancellation reason codes

cancellation_reason_broker
string

Broker-provided cancellation reason

cancel_reason_others
string

Free-text cancellation reason

Response

Cancellation approved

status
string
Example:

"success"

submission_number
string
transaction_id
integer
submission_status
string