DocumentSendSettingsInput

All settings for sending a document. Used by the send, sendBatchDocument, and addBulkDocument mutations.

Fields

Field	Type	Required	Default	Description
groupId	ID!	Yes	—	Group to send from
title	String	No	—	Document title
templateId	ID	No	—	Source template ID
recipients	[RecipientInput]	No	—	List of recipients
participantFields	[FieldInput]	No	—	Signer field values
senderFields	[FieldInput]	No	—	Sender field values
documentCCEmail	[AWSEmail]	No	—	Additional CC emails
allowCopying	Boolean!	No	false	Allow copying final PDF
allowPrinting	Boolean!	No	false	Allow printing final PDF
tag	String	No	—	Tag for the document
sequentialSigning	Boolean	No	—	Send recipients in order
pdfPassword	String	No	—	Password for final PDF
retainPdfPassword	Boolean	No	—	Keep password after completion
suppressEmails	Boolean	No	—	Suppress all emails

Example

mutation SendDocument {
  send(input: {
    groupId: "Z3JwbGVnYWxlc2lnbxRldg=="
    title: "Employment Contract"
    templateId: "dHBsYjQ5YTg5NWQ="
    recipients: [{
      id: "cm9sZTEyMzQ1Ng=="
      firstName: "Jane"
      lastName: "Smith"
      email: "jane@example.com"
      role: "Signer"
      roleId: "cm9sZTEyMzQ1Ng=="
      order: 1
      signerIndex: 1
    }]
    allowCopying: false
    allowPrinting: false
  })
}

Complete JSON structure

The send mutation accepts AWSJSON, so the input is a JSON object. This is the full structure with all fields:

{
  "groupId": "Z3JwMTIzNDU2",
  "templateId": "dHBsMTIzNDU2",
  "title": "Employment Contract - Jane Smith",
  "sequentialSigning": true,
  "allowCopying": false,
  "allowPrinting": false,
  "suppressEmails": false,
  "tag": "",
  "pdfPassword": "",
  "retainPdfPassword": false,
  "documentCCEmail": [],
  "recipients": [
    {
      "id": "cm9sMTIzNDU2",
      "roleId": "cm9sMTIzNDU2",
      "role": "",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "jane@example.com",
      "phoneNumber": "+447700900000",
      "order": 0,
      "signerIndex": 1,
      "channel": "EMAIL",
      "experience": "ZXhwMTIzNDU2",
      "scheduleId": "c2NoMTIzNDU2",
      "message": "Dear {{signer_firstname}},\n\nPlease sign {{doc_name}}.\n\nContact {{sender_fullname}} with questions.",
      "attachments": ["YXR0MTIzNDU2"],
      "expiryDate": "2026-12-31T09:00:00.000Z",
      "skipped": false,
      "timeZone": "Europe/London"
    }
  ],
  "senderFields": [
    { "id": "ZWxlMTIzNDU2", "value": "Acme Corp" }
  ],
  "participantFields": [
    { "id": "ZWxlNzg5MDEy", "value": "" }
  ]
}

Key notes:

• id and roleId on a recipient are usually the same base64-encoded template role ID, but id can be an arbitrary string.
• role can be empty string when roleId is provided.
• message supports placeholders: {{signer_firstname}}, {{signer_lastname}}, {{sender_fullname}}, {{doc_name}}.
• expiryDate is ISO 8601 or null for no expiry.
• signerIndex uses 1+ for signers, 101+ for witnesses.
• To skip a recipient, omit them from the array entirely.
• Only groupId, templateId, and recipients are required. All other fields are optional.

A downloadable JSON Schema is available for editor autocomplete and validation.

Related

• RecipientInput — recipient details
• FieldInput — pre-filled field values
• Send Input JSON Schema — downloadable schema for validation and editor autocomplete