Skip to main content

startBulk

Create a new bulk send task. Returns a bulk ID (UUID) for use with addBulkDocument and sendBulk.

The full bulk flow is:

  1. startBulk → returns bulk ID (UUID)
  2. addBulkDocument × N → queue documents
  3. sendBulk → sends all queued documents

Input​

StartBulkInput

Return Type​

ID — the bulk ID (UUID).

Example​

mutation StartBulk {
  startBulk(input: {
    groupId: "Z3JwMTIzNDU2"
    name: "March Contracts"
  })
}

Export This Article

Save a copy of this page as PDF or plain text.