sendBatch

Begins the execution of a batch Send task. Returns an ID that you use in subsequent sendBatchDocument calls to add documents to the batch, then startBatch to send them all.

Input

SendBatchInput

Return Type

ID — the batch ID.

Example

mutation CreateBatch {
  sendBatch(input: {
    groupId: "Z3JwMTIzNDU2"
    batchName: "Q3 Contracts"
    enforceOrder: true
    notifySender: true
  })
}

Related

• sendBatchDocument — add documents to the batch
• startBatch — mark batch as ready to send
• Batch type