Remove a queued export's job (internal)

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://docs.usehearsay.com/mcp

Standard setup for AI tools providing an mcp.json file

{
  "integrations MCP server": {
    "url": "https://docs.usehearsay.com/mcp"
  }
}

DELETE /admin/exports/{id}/job

Access token

Takes the export's job out of the export queue and leaves the export not started; it is not cancelled and runs only once re-run or resumed. When no live job is found the response says so instead of failing. A job a worker already picked up returns 400, several queued jobs 409, an unreadable queue 500, an unknown export 404 and 403 while queue operations are turned off. Super admin only.

Path parameters

id string Required

Id of the export whose queue job should be removed

Responses

200 application/json
Hide response attributes Show response attributes object
- data object Required
  
  Hide data attributes Show data attributes object
  
  exportId string Required
  
  jobRemoved boolean Required
  
  False when nothing was removed — no live queue job was FOUND for the export, or the job was gone by the time the removal ran. A legitimate outcome rather than a failure, because the end state you asked for appears to already hold; read the message, which is careful to say "appears", because nothing here can prove a negative about the queue.
  
  removedFromState string | null Required
  
  The queue state the removed job was in; null when nothing was removed.
  
  status string Required
  
  What the export row reads now. Always notstarted — a dequeue is queue hygiene, not a cancellation, and leaves the export re-queueable.
  
  Values are not-started, inprogress, completed, failed, or cancelled.
  
  message string Required
  
  Plain-English summary of what happened, safe to show as-is.
- statusCode number Required
- timestamp string(date-time) Required

DELETE /admin/exports/{id}/job

curl \
 --request DELETE 'http://api.example.com/admin/exports/{id}/job' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": {
    "exportId": "65a1b2c3d4e5f6a7b8c9d0f1",
    "jobRemoved": true,
    "removedFromState": "waiting",
    "status": "not-started",
    "message": "Queue job removed; the export is not started and stays re-queueable."
  },
  "statusCode": 200,
  "timestamp": "2026-01-15T10:15:00.000Z"
}