Interface ICreateEnvelopeRole

Whether the recipient may delegate their tasks to others. Should be false for most standard workflows.

The email address of the recipient. One of email or phone must be provided.

The full name of the recipient as it will be displayed in reports and queries, e.g. 'Paige Turner'.

A custom message to include in the email or SMS invitation. May be left blank for a default message.

The Role name of the recipient. Please note this is not the person's name. It is the ID of the role, e.g. 'Recipient 1', 'Seller', etc. This must match one of the pre-defined roles in the template's Recipients list.

The phone number of the recipient. One of email or phone must be provided. If phone is included, the recipient will receive an SMS notification for the document.

The 1-based sequence number for the recipient. This can be used to override the template's workflow. Recipients are processed in parallel for each matching sequence number (e.g. all recipients at level "1" may act in parallel) and in series between sequence numbers (e.g. all recipients at level "1" must complete their tasks before recipients at level "2" may act).

The type of role to create. Most participants in standard flows will be "signer" recipients.