Skip to content
ValidationCheck

Cancel a bulk job

DELETE
/v1/bulk/jobs/{id}
curl --request DELETE \
  --url https://api.validationcheck.net/v1/bulk/jobs/example \
  --header 'Authorization: Bearer <token>'

Stops checking inputs that haven’t been reached yet; they aren’t charged. Results so far stay available.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Responses

Section titled “Responses”

200

Section titled “200”

Cancelled

Media typeapplication/json
object
success
required
boolean
data
required
object
id
required
string
name
required
string
type
required
string
Allowed values: email phone phone_type ip domain_age email_auth
status
required
string
Allowed values: queued running completed cancelled failed
total_rows
required
number
unique_inputs
required
number
processed
required
number
credits_used
required
number
results
required
object
approve
required
number
verify
required
number
review
required
number
block
required
number
errors
required
number
skipped
required
number
cache_hits
required
number
created_at
required
string
completed_at
required
string | null
expires_at
required

Results and files are deleted 7 days after the job was created.

string

Example 

{
  "success": true,
  "data": {
    "type": "email",
    "status": "queued"
  }
}

400

Section titled “400”

Error

Media typeapplication/json
object
success
required
boolean
error
required
object
code
required
string
Allowed values: INVALID_REQUEST INVALID_INPUT MISSING_FIELD UNAUTHORIZED INSUFFICIENT_CREDITS FORBIDDEN_SCOPE ACCOUNT_SUSPENDED NOT_FOUND IDEMPOTENCY_CONFLICT INPUT_LIMIT_EXCEEDED RATE_LIMITED INTERNAL_ERROR UPSTREAM_UNAVAILABLE MAINTENANCE
message
required
string
docs_url
required
string format: uri
request_id
required
string

Example 

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST"
  }
}

401

Section titled “401”

Error

Media typeapplication/json
object
success
required
boolean
error
required
object
code
required
string
Allowed values: INVALID_REQUEST INVALID_INPUT MISSING_FIELD UNAUTHORIZED INSUFFICIENT_CREDITS FORBIDDEN_SCOPE ACCOUNT_SUSPENDED NOT_FOUND IDEMPOTENCY_CONFLICT INPUT_LIMIT_EXCEEDED RATE_LIMITED INTERNAL_ERROR UPSTREAM_UNAVAILABLE MAINTENANCE
message
required
string
docs_url
required
string format: uri
request_id
required
string

Example 

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST"
  }
}

402

Section titled “402”

Error

Media typeapplication/json
object
success
required
boolean
error
required
object
code
required
string
Allowed values: INVALID_REQUEST INVALID_INPUT MISSING_FIELD UNAUTHORIZED INSUFFICIENT_CREDITS FORBIDDEN_SCOPE ACCOUNT_SUSPENDED NOT_FOUND IDEMPOTENCY_CONFLICT INPUT_LIMIT_EXCEEDED RATE_LIMITED INTERNAL_ERROR UPSTREAM_UNAVAILABLE MAINTENANCE
message
required
string
docs_url
required
string format: uri
request_id
required
string

Example 

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST"
  }
}

403

Section titled “403”

Error

Media typeapplication/json
object
success
required
boolean
error
required
object
code
required
string
Allowed values: INVALID_REQUEST INVALID_INPUT MISSING_FIELD UNAUTHORIZED INSUFFICIENT_CREDITS FORBIDDEN_SCOPE ACCOUNT_SUSPENDED NOT_FOUND IDEMPOTENCY_CONFLICT INPUT_LIMIT_EXCEEDED RATE_LIMITED INTERNAL_ERROR UPSTREAM_UNAVAILABLE MAINTENANCE
message
required
string
docs_url
required
string format: uri
request_id
required
string

Example 

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST"
  }
}

404

Section titled “404”

Error

Media typeapplication/json
object
success
required
boolean
error
required
object
code
required
string
Allowed values: INVALID_REQUEST INVALID_INPUT MISSING_FIELD UNAUTHORIZED INSUFFICIENT_CREDITS FORBIDDEN_SCOPE ACCOUNT_SUSPENDED NOT_FOUND IDEMPOTENCY_CONFLICT INPUT_LIMIT_EXCEEDED RATE_LIMITED INTERNAL_ERROR UPSTREAM_UNAVAILABLE MAINTENANCE
message
required
string
docs_url
required
string format: uri
request_id
required
string

Example 

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST"
  }
}

413

Section titled “413”

Error

Media typeapplication/json
object
success
required
boolean
error
required
object
code
required
string
Allowed values: INVALID_REQUEST INVALID_INPUT MISSING_FIELD UNAUTHORIZED INSUFFICIENT_CREDITS FORBIDDEN_SCOPE ACCOUNT_SUSPENDED NOT_FOUND IDEMPOTENCY_CONFLICT INPUT_LIMIT_EXCEEDED RATE_LIMITED INTERNAL_ERROR UPSTREAM_UNAVAILABLE MAINTENANCE
message
required
string
docs_url
required
string format: uri
request_id
required
string

Example 

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST"
  }
}