batches

Appends one chunk of emails to a batch whose intake is still open (submitted with `final: false`).

post/api/batches/{uuid}/emails

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/{uuid}/emails
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

uuidstring required

Public UUID of the batch.

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 in this chunk. May be empty (a pure "close intake now" call).

finalboolean

Whether this is the batch's final chunk; closes intake and completes the batch when every job (old and new) is already processed. Defaults to true.

Response

Chunk accepted and queued.

batch_uuidstring required

Public UUID of the batch.

duplicatesinteger required

Number of addresses in this chunk that were duplicates within the same chunk.

estimated_costinteger required

Tokens reserved for this chunk.

statusstring required

Status of the batch right after this chunk.

syntax_errorsinteger required

Number of addresses in this chunk that failed syntax validation.

total_jobsinteger required

Cumulative number of unique valid emails queued as jobs across every chunk so far.

Changes

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