logo
EnrichmentCancel a job

Cancel a job

Cancels an enrichment job that is in pending or processing status. Jobs that are already completed, failed, or cancelled cannot be cancelled.

curl -X POST "https://api.sendkit.ai/v1/enrichment/jobs/example_string/cancel" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY"
{
  "success": true,
  "data": {
    "id": "bulk_email_verification_1710000000000_abc1234",
    "type": "email_verification",
    "status": "cancelled",
    "metadata": {
      "totalItems": 100,
      "processedItems": 0,
      "successCount": 0,
      "failedCount": 0,
      "creditsUsed": 100
    },
    "updatedAt": "2025-03-19T10:01:00.000Z",
    "completedAt": "2025-03-19T10:01:00.000Z"
  }
}
POST
/v1/enrichment/jobs/{jobId}/cancel
POST
API Key (header: X-Api-Key)
X-Api-Keystring
Required

Platform API key (sk_user_...) or Workspace API key (sk_...)

Platform API key (sk_user_...) or Workspace API key (sk_...)
path
jobIdstring
Required

The enrichment job ID to cancel

Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)

Path Parameters

jobIdstring
Required

The enrichment job ID to cancel

Responses

successboolean
dataobject