RecipientInput

Recipient details when sending a document. Used within DocumentSendSettingsInput.

Fields

Field	Type	Required	Default	Description
id	ID!	Yes	—	Role ID from the template
firstName	String	No	—	First name. Empty string for "to be decided" recipients
lastName	String	No	—	Last name. Empty string for "to be decided" recipients
email	String	No	—	Email address. Empty string for "to be decided" recipients
phoneNumber	String	No	—	Phone number (E.164 format)
expiryDate	AWSDateTime	No	—	When the invitation expires
role	String	No	—	Role description. Can be empty string when roleId is provided
order	Int	No	—	Send order for this request
signerIndex	Int	No	—	Field indicator number. Signers use 1+, witnesses use 101+
schedule	[ScheduleItemInput]	No	—	Custom reminder schedule
scheduleId	ID	No	—	Preset schedule ID
message	String	No	—	Email message body. Supports placeholders: {{signer_firstname}}, {{signer_lastname}}, {{sender_fullname}}, {{doc_name}}
attachments	[ID]	No	—	Attachment IDs to include
experience	ID	No	—	Experience ID for signing
skipped	Boolean	No	—	Skip this recipient
roleId	ID	No	—	Role ID (auto-populates signerIndex, order, experience)
timeZone	String	No	—	Recipient's time zone
channel	ChannelType	No	EMAIL	Communication channel
ccFirstName	String	No	—	CC first name
ccLastName	String	No	—	CC last name
ccEmail	String	No	—	CC email address
ccMessage	String	No	—	CC message
ccIncludeLink	Boolean	No	—	Include signing link in CC
ccToggleValue	Boolean	No	—	Deprecated

Skipping recipients

To skip a recipient (e.g. a witness that isn't needed), omit them from the recipients array entirely. The remaining recipients should have their order values re-indexed starting from 0. Template-level fields (senderFields, participantFields) are unaffected — include all of them regardless of which recipients are skipped.

Example

recipients: [{
  id: "cm9sZS0x"
  firstName: "Jane"
  lastName: "Smith"
  email: "jane@example.com"
  role: "Signer"
  channel: EMAIL
  experience: "ZXhwLWRlZmF1bHQ="
  schedule: [{
    daysAfter: 3
    frequency: 7
    when: 2
    timeOfDay: "09:00:00"
  }]
}]

Related

• DocumentSendSettingsInput — parent input
• ScheduleItemInput — custom reminder schedule
• ChannelType — communication channels