addBulkDocument

SRP

Add a document to the queue for a particular bulk send request. You should have already called startBulk to get the bulk ID.

Input

AddBulkDocumentInput

The nested input.document object uses the same validation rules as DocumentSendSettingsInput, including ID format checks, string length limits, and collection size limits.

Return Type

ID

Example

mutation AddBulkDoc {
  addBulkDocument(input: {
    bulkId: "37fdd3ac-b9a3-4de3-9696-cbdda970ed61"
    sendOrder: 0
    document: {
      groupId: "Z3JwMTIzNDU2Nzg5MC1hYmNkLWVmMDEtMjM0NTY3ODlhYmNk"
      templateId: "dHBsMTIzNDU2Nzg5MC1hYmNkLWVmMDEtMjM0NTY3ODlhYmNk"
      title: "Invoice - Client A"
      recipients: [
        {
          firstName: "Alice"
          lastName: "Jones"
          email: "alice@example.com"
          order: 0
        }
      ]
    }
  })
}

Related

• sendBulk
• startBulk
• Troubleshoot Send Validation — nested document input uses the same validation rules