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
templateId	ID!	Yes	—	Source template ID
title	String!	Yes	—	Document title
recipients	[RecipientInput]!	Yes	—	List of recipients
sequentialSigning	Boolean	No	Group default	Send recipients in order
allowCopying	Boolean	No	Group default	Allow copying final PDF
allowPrinting	Boolean	No	Group default	Allow printing final PDF
suppressEmails	Boolean	No	false	Suppress all emails
tag	String	No	""	Tag for the document
pdfPassword	String	No	Group default	Password for final PDF
retainPdfPassword	Boolean	No	Group default	Keep password after completion
documentCCEmail	[AWSEmail]	No	Group default	Additional CC emails
redirect	String	No	Group default	URL to redirect recipients to after signing
senderFields	[FieldInput]	No	—	Sender field values
participantFields	[FieldInput]	No	—	Signer field values

Validation Rules

• groupId must be a base64-encoded ID that decodes to grp followed by a non-empty string suffix up to 60 characters.
• templateId must be a base64-encoded ID that decodes to tpl followed by a UUID.
• title maximum length: 1028 characters.
• tag maximum length: 250 characters.
• pdfPassword maximum length: 150 characters.
• documentCCEmail may contain at most 10 email addresses.
• recipients must contain fewer than 200 items.
• senderFields must contain fewer than 1000 items.
• participantFields must contain fewer than 1000 items.

These same rules apply when this structure is nested under document in sendBatchDocument and addBulkDocument.

Example

mutation SendDocument {
  send(input: {
    groupId: "Z3JwbGVnYWxlc2lnbxRldg=="
    title: "Employment Contract"
    templateId: "dHBsYjQ5YTg5NWQ="
    recipients: [{
      roleId: "cm9sZTEyMzQ1Ng=="
      firstName: "Jane"
      lastName: "Smith"
      email: "jane@example.com"
      order: 0
    }]
  })
}

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": [],
  "redirect": "",
  "recipients": [
    {
      "roleId": "cm9sMTIzNDU2",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "jane@example.com",
      "order": 0,
      "phoneNumber": "+447700900000",
      "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",
      "timeZone": "Europe/London",
      "ccEmail": "manager@example.com",
      "ccFirstName": "Bob",
      "ccLastName": "Jones",
      "ccMessage": "For your records.",
      "ccIncludeLink": true
    }
  ],
  "senderFields": [
    { "id": "ZWxlMTIzNDU2", "value": "Acme Corp" }
  ],
  "participantFields": [
    { "id": "ZWxlNzg5MDEy", "value": "" }
  ]
}

Key notes:

• roleId is optional. When provided, it is the base64-encoded template role ID that links the recipient to template fields.
• Encoded IDs use fixed decoded prefixes: groupId=grp, templateId=tpl, roleId=rol, experience=exp, field id=ele, attachment id=att. groupId accepts any non-empty suffix up to 60 characters after grp. experience accepts any non-empty suffix after exp. scheduleId is the exception and decodes to sch followed by an integer.
• message supports placeholders: {{signer_firstname}}, {{signer_lastname}}, {{sender_fullname}}, {{doc_name}}.
• expiryDate is ISO 8601 or null for no expiry.
• When optional fields are omitted, group-level defaults are used where available.
• To skip a recipient, omit them from the array entirely.

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

Related

• RecipientInput — recipient details
• FieldInput — pre-filled field values
• ScheduleItemInput — inline reminder schedule items
• Send Input JSON Schema — downloadable schema for validation and editor autocomplete
• Troubleshoot Send Validation — common validation failures and how to inspect task.report.errors