Skip to main content
Input object Submit an asynchronous bulk operation across your connected users.

Input fields

BulkOperationType!
required
The operation to perform across the target users.
BulkTargetSpecInput
Which connected users this operation applies to. Required ONLY for the read exports (GET_BALANCES_EXPORT, GET_TRANSACTIONS_EXPORT). The write operations (CREATE_TRANSFER, DEPOSIT_CASH_BALANCE, UPDATE_TRANSACTION_METADATA) name their targets in their own items, so targetSpec is ignored for those.
BulkExportOptionsInput
Options for the read-export operations. Ignored by other operations.
BulkTransferOptionsInput
Per-destination amounts for CREATE_TRANSFER. Required for that operation; ignored by others.
BulkDepositOptionsInput
Per-target deposits for DEPOSIT_CASH_BALANCE. Required for that operation; ignored by others.
BulkMetadataOptionsInput
Per-target transaction edits for UPDATE_TRANSACTION_METADATA. Required for that operation; ignored by others.
String
Your idempotency key for this submission. May instead be supplied via the Idempotency-Key header; if both are given they must match. Reusing a key with a different request is rejected.