Abort a history backfill job

POST 
/v1/imap/:mailerID/history/:jobId/abort

Cancels an in-flight history backfill job. The worker's slice loop stops cleanly at its next iteration, leaving the job in a terminal 'cancelled' state. A job owned by another tenant or an unknown job returns 404; a job already finished (done/failed/cancelled) returns 409. History backfill is currently supported only for Google (Gmail) OAuth IMAP mailboxes.

Request

Path Parameters

mailerID stringrequired

Mailer ID

jobId stringrequired

History backfill job ID

Responses

200

History backfill cancelled

application/json

Schema

Schema

jobId string
status string
success boolean

Example (from schema)

{
  "jobId": "01JC3BBW8S9YGX2VNKG5MD7BTA",
  "status": "cancelled",
  "success": true
}

400

Bad Request

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": false
}

404

Job not found

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": false
}

409

Job already finished

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": false
}

Loading...