batches

Submits a list of emails for bulk verification.

post/api/batches

Request

  • Base URL: https://api.pricklymails.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pricklymails.com/api/batches
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

checksstring[] nullable

Optional explicit check names; defaults to every check the caller's plan allows.

custom_idsstring[]

Optional per-email client references, index-aligned 1:1 with emails; empty means none.

emailsstring[] required

Email addresses to verify.

finalboolean

Whether this is the batch's only (or final) chunk. Defaults to true, the single-shot behavior.

namestring nullable

Optional display name for the batch.

Response

Batch accepted and queued.

batch_uuidstring required

Public UUID of the batch. Use it with GET /api/batches/{uuid} to poll status.

duplicatesinteger required

Number of submitted addresses that were exact duplicates of an already-accepted one.

estimated_costinteger required

Total tokens reserved for the batch.

statusstring required

Status of the batch right after submit (always "processing").

syntax_errorsinteger required

Number of submitted addresses that failed syntax validation.

total_jobsinteger required

Number of unique valid emails queued as jobs.

Changes

No recorded changes to this operation across all 1 revision of this API.