Batch

Submit a Mixed-Product Batch

Submit a batch containing items for one or more enrichment products.

post/v1/batch

Request

idempotencyKeystring

Submitting the same key twice returns the original batch instead of creating a duplicate.

metadataobject

Arbitrary metadata stored with the batch.

client_idstring

Associate the whole batch with a client record.

client_namestring

Client name recorded alongside the batch.

budget_user_idstring

Charge the batch against this member's credit budget.

webhook_urlstring uri

HTTPS URL notified when the batch completes. SSRF-validated: must resolve to a public IP.

priority'normal' | 'low'

Queue priority for this batch.

{
  "items": [
    {
      "product": "email_validation",
      "input": {
        "email": "alex.rivera@example.com"
      }
    }
  ]
}

Batch accepted.

object required