append_batch_emails
Append a chunk of emails (up to 4096) to a batch created by submit_batch with final: false, so a bulk job can grow past the single-call cap. Reserves and queues this chunk exactly like submit_batch, and accepts the same optional checks field; a streamed caller should pass the same checks on every chunk so the whole batch runs one check set. Pass the same api_key used on the original submit_batch call to keep billing and scoping on that account; omit it to use the caller's own session account. Requires the email:verify:bulk scope on whichever account ends up authenticating the call. Set final_chunk true on the last chunk to close intake; the batch then completes once every job (old and new) finishes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| final | No | Whether this is the batch's final chunk (defaults to true). Set false to keep intake open for a further append_batch_emails call. | |
| checks | No | Optional check wire strings (syntax, mx, smtp, disposable, role, free, catchall); defaults to every check the caller's plan allows, smtp included. A streamed caller should pass the same checks on every chunk so the whole batch runs one check set. | |
| emails | Yes | Email addresses to verify in this chunk (up to 4096). May be empty to close intake without adding more emails. A final chunk is refused when the batch would close with fewer than batch_min (20) distinct valid addresses; the batch then stays open. | |
| api_key | No | Optional pm_live_ (or pm_test_) API key, matching the one used on the original submit_batch call. When present, this chunk is billed and scoped against that key's own account instead of the caller's session account, and the key must carry the email:verify:bulk scope. Omit to use the caller's own session account. | |
| batch_uuid | Yes | Public batch UUID of an open batch (created by submit_batch with final: false). | |
| custom_ids | No | Optional per-email client references, index-aligned 1:1 with emails. Echoed back verbatim in get_batch_results so you can map each result to your input row. Do not put the email address or any PII here, use your own row identifier (e.g. a CRM id). |