sendBatchDocument

SRPAPI Key

Adds a document to a batch with an ID provided by sendBatch.

Input

SendBatchDocumentInput

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 AddDocumentToBatch {
  sendBatchDocument(input: {
    batchId: "2c66a692-89c1-412d-a316-cc0dbb67e978"
    sendOrder: 0
    document: {
      groupId: "Z3JwMTIzNDU2Nzg5MC1hYmNkLWVmMDEtMjM0NTY3ODlhYmNk"
      templateId: "dHBsMTIzNDU2Nzg5MC1hYmNkLWVmMDEtMjM0NTY3ODlhYmNk"
      title: "Contract - Jane Smith"
      recipients: [
        {
          firstName: "Jane"
          lastName: "Smith"
          email: "jane@example.com"
          order: 0
        }
      ]
    }
  })
}

Related

• sendBatch — create the batch first
• startBatch — send all queued documents
• Troubleshoot Send Validation — nested document input uses the same validation rules