View as Markdown

Cancel Email Verification

POST/v2/email-verifications/{id}/cancel

Cancel a bulk email verification job and refund the credits of the rows it has not verified. Free: no credits. A job is cancellable while queued, counting, awaiting_confirmation or verifying; the refund is made at most once.

Path parameters

  • idstringrequired

    The verification job id: the id that POST /v2/email-verifications answers and GET /v2/email-verifications lists.

Responses

  • 200 The job, cancelled.
  • 400 Malformed id (VALIDATION_ERROR, no payload.code).
  • 401 Missing, unknown or inactive credentials (UNAUTHORIZED).
  • 404 No such record in this workspace (NOT_FOUND).
  • 409 The job is already finished (CONFLICT, invalid_state; payload.status names its state).
  • 500 Unexpected server error.

For error handling see Errors.