Action: Create Draft Signature Request

Docusign Operation

The Create Draft Signature Request action prepares a new envelope in Docusign with documents and recipients but does not send it yet, allowing for review or modifications before sending.

Example User Story

I want to create a draft signature request so I can review and adjust the documents and recipients before sending it out for signatures.

Fields

Field Name	Field Type	Required
templateId	String	Yes
signerEmail	String	Yes
signerName	String	Yes
subject	String	No
message	String	No

Related Connections

Docusign

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "create-draft-signature-request",
  "state": "inDev",
  "meta": {
    "short": "Create Draft Signature Request",
    "description": "Creates a draft signature request in DocuSign"
  },
  "input": [
    {
      "name": "templateId",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The ID of the template to use for the signature request"
      }
    },
    {
      "name": "signerEmail",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The email of the signer"
      }
    },
    {
      "name": "signerName",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The name of the signer"
      }
    },
    {
      "name": "subject",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The subject of the signature request email"
      }
    },
    {
      "name": "message",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The message body of the signature request email"
      }
    }
  ],
  "output": [
    {
      "name": "envelopeId",
      "type": "String",
      "selector": ["envelopeId"],
      "meta": {
        "description": "The ID of the created envelope"
      }
    },
    {
      "name": "status",
      "type": "String",
      "selector": ["status"],
      "meta": {
        "description": "The status of the created envelope"
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": "/v2.1/accounts/{{accountId}}/envelopes",
        "headers": {
          "Content-Type": "application/json"
        },
        "bodyTemplate": {
          "value": "{\"status\":\"created\",\"templateId\":\"{{templateId}}\",\"templateRoles\":[{\"email\":\"{{signerEmail}}\",\"name\":\"{{signerName}}\",\"roleName\":\"signer\"}],\"emailSubject\":\"{{subject}}\",\"emailBlurb\":\"{{message}}\"}",
          "placeholders": [
            {
              "name": "templateId",
              "type": "String",
              "description": "The ID of the template to use for the signature request",
              "required": true
            },
            {
              "name": "signerEmail",
              "type": "String",
              "description": "The email of the signer",
              "required": true
            },
            {
              "name": "signerName",
              "type": "String",
              "description": "The name of the signer",
              "required": true
            },
            {
              "name": "subject",
              "type": "String",
              "description": "The subject of the signature request email",
              "required": false
            },
            {
              "name": "message",
              "type": "String",
              "description": "The message body of the signature request email",
              "required": false
            }
          ]
        }
      }
    }
  ]
}