Skip to main content
POST
Cancel Job

Overview

Cancel a batch job that is not already in a terminal state.

Authentication

Path parameters

Request Body

Example cURL

Response

Success (200)

Error responses

409 Already cancelled
Use the playground on the right to try this endpoint with your API key.

Authorizations

X-API-Key-ID
string
header
required

Your Gnani Prisma v2.5 API key

Path Parameters

job_id
string
default:019fa854-1db0-7e45-a026-7a6b09ff6d7c
required

Job ID returned by Create Job. Paste the UUID from the Create Job response.

Body

application/json
reason
string

Optional cancel reason

Example:

"Docs verification cancel test"

Response

Cancelled

The response is of type object.