create_batch
Submit bulk imports of contacts or gifts to run through matching, validation, and deduplication, reducing API calls by batching.
Instructions
MUTATING: submit a BULK import of contacts or gifts (the rate-limit-friendly, Virtuous-recommended way to load many records at once).
Virtuous best practices say: to load many gifts/contacts, post them through the BATCH endpoints rather than one transaction per call. This both runs the records through Virtuous's matching/validation/dedupe pipeline AND makes far fewer requests against the ORG-WIDE rate budget (one batch call instead of N).
'contact' -> POST /api/Contact/Batch 'gift' -> POST /api/v2/Gift/Transactions DO NOT call with confirm=true unless the user explicitly approved it. With confirm=false this performs no change and returns a preview (including how many records are in the batch).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Bulk payload. For 'gift' this is typically a list of gift transaction objects (same shape as a single gift transaction). For 'contact' this is the contact-import batch payload. Use describe_endpoint on the target path for the exact schema. | |
| kind | Yes | 'contact' or 'gift' — which bulk import to submit. | |
| confirm | No | Must be true to actually submit. Set ONLY after explicit user approval. |