Action: Send Envelope Using Document

Docusign Operation

The Send Envelope Using Document action initiates a signature request by sending a specified document to designated recipients via Docusign.

Example User Story

I want to send a contract for signature using a prepared document so the recipient can review and sign it quickly.

Fields

Field Name	Field Type	Required
documentId	String	Yes
recipientEmail	String	Yes
recipientName	String	Yes
subject	String	No
message	String	No
envelopeId	String	No
status	String	No

Related Connections

Docusign

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "send-envelope-using-document",
  "state": "inDev",
  "meta": {
    "short": "Send Envelope Using Document",
    "description": "Sends an envelope using a document in Docusign."
  },
  "input": [
    {
      "name": "documentId",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The ID of the document to be sent."
      }
    },
    {
      "name": "recipientEmail",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The email of the recipient."
      }
    },
    {
      "name": "recipientName",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The name of the recipient."
      }
    },
    {
      "name": "subject",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The subject of the envelope."
      }
    },
    {
      "name": "message",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The message to be included in the envelope."
      }
    }
  ],
  "output": [
    {
      "name": "envelopeId",
      "type": "String",
      "selector": ["envelopeId"],
      "meta": {
        "description": "The ID of the sent envelope."
      }
    },
    {
      "name": "status",
      "type": "String",
      "selector": ["status"],
      "meta": {
        "description": "The status of the sent envelope."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": "/v2.1/accounts/{{accountId}}/envelopes",
        "headers": {
          "Content-Type": "application/json"
        },
        "bodyTemplate": {
          "value": "{\n  \"emailSubject\": \"{{subject}}\",\n  \"documents\": [\n    {\n      \"documentId\": \"{{documentId}}\",\n      \"name\": \"Document\"\n    }\n  ],\n  \"recipients\": {\n    \"signers\": [\n      {\n        \"email\": \"{{recipientEmail}}\",\n        \"name\": \"{{recipientName}}\",\n        \"recipientId\": \"1\",\n        \"routingOrder\": \"1\"\n      }\n    ]\n  },\n  \"status\": \"sent\"\n}",
          "placeholders": [
            {
              "name": "accountId",
              "type": "String",
              "description": "The ID of the Docusign account.",
              "required": true
            },
            {
              "name": "accessToken",
              "type": "String",
              "description": "The access token for Docusign API.",
              "required": true
            },
            {
              "name": "documentId",
              "type": "String",
              "description": "The ID of the document to be sent.",
              "required": true
            },
            {
              "name": "recipientEmail",
              "type": "String",
              "description": "The email of the recipient.",
              "required": true
            },
            {
              "name": "recipientName",
              "type": "String",
              "description": "The name of the recipient.",
              "required": true
            },
            {
              "name": "subject",
              "type": "String",
              "description": "The subject of the envelope.",
              "required": false
            }
          ]
        }
      }
    }
  ]
}