Docusign · Schema

TemplateRole

Maps a recipient to a role defined in a template. Used when creating an envelope from a template.

AgreementsContractsDigital Transaction ManagementDocumentsElectronic SignatureseSignature

Properties

Name Type Description
name string The recipient's full name.
email string The recipient's email address.
roleName string The role name that matches a role defined in the template.
clientUserId string The client user ID for embedded signing.
defaultRecipient string When true, this is the default recipient for the role.
routingOrder string The routing order for the recipient.
accessCode string Access code for authentication.
View JSON Schema on GitHub

JSON Schema

docusign-esignature-template-role-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "TemplateRole",
  "type": "object",
  "description": "Maps a recipient to a role defined in a template. Used when creating an envelope from a template.",
  "properties": {
    "name": {
      "type": "string",
      "description": "The recipient's full name."
    },
    "email": {
      "type": "string",
      "description": "The recipient's email address."
    },
    "roleName": {
      "type": "string",
      "description": "The role name that matches a role defined in the template."
    },
    "clientUserId": {
      "type": "string",
      "description": "The client user ID for embedded signing."
    },
    "defaultRecipient": {
      "type": "string",
      "description": "When true, this is the default recipient for the role."
    },
    "routingOrder": {
      "type": "string",
      "description": "The routing order for the recipient."
    },
    "accessCode": {
      "type": "string",
      "description": "Access code for authentication."
    }
  }
}