DocuSign actions

Reference for the DocuSign actions: the sign-in connection, each action id, the fields each executor reads including accountId, outputs and an example.

The DocuSign block sends, reads, lists and voids envelopes through the DocuSign eSignature REST API (v2.1). For the plain-language guide, see DocuSign.

When to use it

Use it to send an envelope prepared in DocuSign, poll its status, list envelopes for a period, or void one. There is no DocuSign trigger.

Connection

Provider id: docusign. Sign-in (OAuth) connection.
Every action is scoped to a DocuSign account and needs accountId in the step config (the DocuSign API account id, a GUID). The connection does not supply it.
Pin an account with config.connection. Without it, the step uses the company's default DocuSign connection.

Actions

Action id	Studio label	What it does
`docusign.sendEnvelope`	Send Envelope	Send an existing draft envelope (sets its status to sent).
`docusign.getEnvelopeStatus`	Get Envelope Status	Read an envelope and its status.
`docusign.listEnvelopes`	List Envelopes	List envelopes, filtered by date, status and search text.
`docusign.voidEnvelope`	Void Envelope	Void an envelope with a reason.

Settings

The Studio fields:

Field	Studio label	Type	Used by	Required for
`connection`	DocuSign Account	string (connection id)	All	Optional. Without it the step uses the company default connection for this system
`envelopeId`	Envelope ID	string	`getEnvelopeStatus`, `voidEnvelope`
`templateId`	Template ID	string	`sendEnvelope`
`recipients`	Recipients (JSON)	json	`sendEnvelope`
`emailSubject`	Email Subject	string	`sendEnvelope`
`voidReason`	Void Reason	string	`voidEnvelope`

Fields each action reads

Action	Fields read
`sendEnvelope`	`accountId`, `envelopeId`. Sets an existing draft envelope's status to `sent`
`getEnvelopeStatus`	`accountId`, `envelopeId`
`listEnvelopes`	`accountId`, and optional `fromDate`, `toDate`, `status`, `count`, `startPosition`, `folderIds`, `searchText`, `order`, `orderBy`, `include`, `userId`, `email`, `userName`
`voidEnvelope`	`accountId`, `envelopeId`, `voidedReason` (or `reason`)

sendEnvelope does not read templateId, recipients or emailSubject, and voidEnvelope does not read the Studio voidReason field. Steps built only in Studio therefore fail with accountId is required or voidedReason is required; set the keys above in the workflow definition.

Output

The step output is the DocuSign response. getEnvelopeStatus returns the envelope, including envelopeId, status and emailSubject. Read it with {{steps.check_envelope.status}}.

Example

Check an envelope's status and void it if it is still out for signature after the deal is lost.

{
  "name": "Void an unsigned envelope",
  "trigger": { "type": "api" },
  "steps": [
    {
      "id": "check_envelope",
      "type": "action",
      "name": "Check the envelope",
      "action": "docusign.getEnvelopeStatus",
      "config": {
        "accountId": "2f1c3a4e-0000-4000-8000-000000000000",
        "envelopeId": "{{input.envelopeId}}"
      }
    },
    {
      "id": "still_out",
      "type": "condition",
      "name": "Still out for signature?",
      "config": {
        "conditions": { "left": "{{steps.check_envelope.status}}", "operator": "eq", "right": "sent" },
        "then": ["void_envelope"]
      }
    },
    {
      "id": "void_envelope",
      "type": "action",
      "name": "Void it",
      "action": "docusign.voidEnvelope",
      "config": {
        "accountId": "2f1c3a4e-0000-4000-8000-000000000000",
        "envelopeId": "{{input.envelopeId}}",
        "voidedReason": "Deal closed lost"
      }
    }
  ]
}

The account id is a fixed value for your DocuSign account, so it is typed into each step.

Other executors

The DocuSign module also has executors the block does not list, such as docusign.createEnvelopeFromTemplate, docusign.downloadDocument and docusign.getAuditEvents. The workflow validator accepts only the operations in the table above.

Live catalog

GET /api/v1/blocks/docusign returns the actions and fields.
GET /api/v1/blocks/docusign/actions/<operation>/examples returns stored examples where they exist.

Errors and limits

A DocuSign API error fails the step.
A missing accountId, envelopeId or voidedReason fails the step before DocuSign is called.

DocuSign actions

On this page