name*string
Name for the new role. Must be unique within the template. May include spaces, but later calls must URL-encode any references to this role, so it is recomended that special characters be avoided.
type*string
Type of role to create. Signers act on documents by filling and signing fields. CC recipients receive a copy but do not act on the document. Approvers control the final submission of a document, but do not have fields of their own to fill out.
Value in"signer" | "cc" | "approver"
full_name?string
Default full name for the role. May be completed/overridden later, when envelopes are made from the template.
email?string
Default email address for the role. May be completed/overridden later, when envelopes are made from the template.
phone?string
Default (SMS-capable) phone number for the role. May be completed/overridden later, when envelopes are made from the template.
message?string
Optional message to include in email and SMS signing invitations.
sequence?integer
Optional 1-based sequence number for the role. Roles that share the same sequence number act in parallel, and will receive invitations at the same time.
order?integer
Optional 1-based order number for the role. Controls the left-to-right display order of roles at the same sequence number in the UI components e.g. <verdocs-template-roles />.
delegator?boolean
If true, the role may delegate their signing responsibility to another party.