RecipientInput

Recipient details when sending a document. Used within DocumentSendSettingsInput.

Fields

Field	Type	Required	Default	Description
id	ID	No	—	Optional recipient ID when updating or reusing recipient details
roleId	ID	No	—	Optional base64-encoded role ID from the template. Use it to link a recipient to template fields, order, and experience when needed
firstName	String	No	—	Recipient's first name
lastName	String	No	—	Recipient's last name
email	String!	Yes	—	Recipient's email address
order	Int!	Yes	—	Send order for sequential signing (0-indexed), and/or to get template role if roleId not used
signerIndex	Int	No	—	Legacy field indicator number for this recipient
phoneNumber	String	No	""	Phone number (E.164 format)
expiryDate	AWSDateTime	No	null	When the invitation expires (ISO 8601). Null for no expiry
schedule	[ScheduleItemInput]	No	—	Inline custom reminder schedule. Use this or scheduleId, not both
scheduleId	ID	No	—	Base64-encoded preset schedule ID
message	ID	No	""	Message ID or value to use for this recipient
attachments	[ID]	No	—	Base64-encoded attachment IDs to include
experience	ID	No	—	Base64-encoded experience value for the signing page. It must decode to exp plus a non-empty suffix
skipped	Boolean	No	—	Whether this recipient should be skipped
timeZone	String	No	—	Recipient's time zone (IANA format, e.g. Europe/London)
channel	ChannelType	No	EMAIL	Communication channel for this recipient
ccFirstName	String	No	—	CC contact first name
ccLastName	String	No	—	CC contact last name
ccEmail	String	No	—	CC contact email address
ccMessage	String	No	—	CC message text
ccIncludeLink	Boolean	No	—	Include signing link in CC email
ccToggleValue	Boolean	No	—	Deprecated CC toggle value

Validation Rules

• firstName maximum length: 60 characters.
• lastName maximum length: 60 characters.
• email maximum length: 75 characters.
• phoneNumber maximum length: 120 characters.
• message maximum length: 8000 characters.
• roleId must decode to rol followed by a UUID.
• experience, when supplied, must be base64-encoded and decode to exp followed by a non-empty string suffix. The suffix does not need to be a UUID.
• scheduleId, when supplied, must decode to sch followed by an integer. Empty string is also allowed.
• attachments entries must decode to att followed by a UUID.
• If schedule is supplied, each item uses the limits documented in ScheduleItemInput.

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: [{
  firstName: "Jane"
  lastName: "Smith"
  email: "jane@example.com"
  order: 0
  experience: "ZXhwLWRlZmF1bHQ="
  schedule: [{
    daysAfter: 3
    frequency: 7
    when: 2
    timeOfDay: "09:00:00"
    subject: "Reminder: please sign"
    message: "Please sign the document."
    skipWeekend: true
  }]
}]

Related

• DocumentSendSettingsInput — parent input
• ScheduleItemInput — custom reminder schedule