Action: Create Bulk Send List

Docusign Operation

The Create Bulk Send List action prepares a list of recipients and documents for sending multiple envelopes in bulk.

Example User Story

I want to create a bulk send list in DocuSign for monthly invoices, so I can send personalized contracts to all clients at once.

Fields

Field Name	Field Type	Required
accountId	String	Yes
bulkSendListName	String	Yes
recipients	Array	Yes
templateId	String	No
bulkSendListId	String	-
status	String	-

Related Connections

Docusign

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "create-bulk-send-list",
  "state": "inDev",
  "meta": {
    "short": "Create Bulk Send List",
    "description": "Creates a bulk send list in DocuSign for sending documents to multiple recipients."
  },
  "input": [
    {
      "name": "accountId",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The DocuSign account ID."
      }
    },
    {
      "name": "bulkSendListName",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The name of the bulk send list."
      }
    },
    {
      "name": "recipients",
      "type": "Array",
      "required": true,
      "meta": {
        "description": "List of recipient details (name, email, etc.)."
      }
    },
    {
      "name": "templateId",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The template ID to use for the bulk send."
      }
    }
  ],
  "output": [
    {
      "name": "bulkSendListId",
      "type": "String",
      "selector": ["bulkSendListId"],
      "meta": {
        "description": "The ID of the created bulk send list."
      }
    },
    {
      "name": "status",
      "type": "String",
      "selector": ["status"],
      "meta": {
        "description": "The status of the bulk send list creation."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": "/v2.1/accounts/{{accountId}}/bulk_send_lists",
        "headers": {
          "Content-Type": "application/json"
        },
        "bodyTemplate": {
          "value": "{\n  \"bulkSendListName\": \"{{bulkSendListName}}\",\n  \"recipients\": {{recipients}},\n  \"templateId\": \"{{templateId}}\"\n}",
          "placeholders": [
            {
              "name": "bulkSendListName",
              "type": "String",
              "description": "Name of the bulk send list.",
              "required": true
            },
            {
              "name": "recipients",
              "type": "Array",
              "description": "List of recipient details.",
              "required": true
            },
            {
              "name": "templateId",
              "type": "String",
              "description": "Template ID for the bulk send.",
              "required": false
            }
          ]
        }
      }
    }
  ]
}