SteveSteve

Cancel a submission

POST/api/v1/submissions/{submissionId}/cancel

Authorization

AuthorizationRequiredBearer <token>

Steve API key, usually scoped to a company. Legacy keys and keys created by platform administrators may be unscoped; company-scoped endpoints reject unscoped keys with 403 Forbidden. Format: Authorization: Bearer aok_...

In: header

Request Body

application/jsonOptional
reasonstring

Path Parameters

submissionIdRequiredstring

Steve submission identifier.

Header Parameters

X-Request-Idstring

Optional caller-supplied request identifier. Maximum length is 128 characters.

Maximum length: 128
curl -X POST "https://your-deployment.convex.site/api/v1/submissions/<string>/cancel" \
  -H "X-Request-Id: <string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "string"
  }'

Submission cancelled

{
  "submissionId": "string",
  "workflow": {
    "slug": "string",
    "version": 0
  },
  "submissionStatus": "created"
}

Previous

Reject a submission in review

Next

Get aggregate batch progress