RecipientUpdateInput

Update a Recipient's details on a sent document.

Fields

Field	Type	Required	Default	Description
recipientId	ID!	Yes	—	Recipient to update
firstName	String	No	—	New first name
lastName	String	No	—	New last name
email	String	No	—	New email address
phoneNumber	String	No	—	New phone number
expiryDate	AWSDateTime	No	—	New expiry date (UTC ISO 8601)
timezone	String	No	—	Recipient's timezone
emailPreviousIfReplaced	Boolean	No	false	Notify previous recipient of change
ifNewRecipientReSendNotification	Boolean	No	—	Re-send notification if email changed
ifNewRecipientEmailMessage	String	No	—	Message for re-sent notification

Example

mutation UpdateRecipient {
  updateRecipient(input: {
    recipientId: "cmVjLTEyMzQ="
    email: "new.email@example.com"
    emailPreviousIfReplaced: true
    ifNewRecipientReSendNotification: true
  })
}