createBulkJob method

Future<BulkValidationJob> createBulkJob({
  1. required List<String> emails,
  2. String? name,
})

Creates a bulk email validation job.

This method creates an asynchronous job to validate multiple email addresses. The job will be processed in the background. Use getJobStatus to check progress or waitForJobCompletion to wait for completion automatically.

emails A list of email addresses to validate. Maximum 50,000 emails per job. name An optional name for the job (useful for tracking multiple jobs).

Returns a BulkValidationJob containing the job ID and initial status.

Throws an ApiException if:

  • The API key is invalid (401)
  • Insufficient credits (402)
  • Too many emails in the list
  • Network or server errors occur

Example:

final job = await client.createBulkJob(
  emails: ['user1@example.com', 'user2@example.com'],
  name: 'My Email List',
);
print('Job created: ${job.id}');

Implementation

Future<BulkValidationJob> createBulkJob({
  required List<String> emails,
  String? name,
}) async {
  final request = BulkValidationRequest(emails: emails, name: name);
  return _request<BulkValidationJob>(
    'POST',
    '/api/v1/batch',
    request.toJson(),
    (json) => BulkValidationJob.fromJson(json),
  );
}