Action: Void Envelope

Docusign Operation

The Void Envelope action cancels a sent envelope, preventing any further signing or access by recipients.

Example User Story

I want to void a DocuSign envelope sent to the wrong client, so I can correct the recipient and resend the document.

Fields

Field Name	Field Type	Required
envelopeId	String	Yes
voidReason	String	No

Related Connections

Docusign

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "void-envelope",
  "state": "inDev",
  "meta": {
    "short": "Void Envelope",
    "description": "Voids an envelope in DocuSign, making it unavailable for further actions."
  },
  "input": [
    {
      "name": "envelopeId",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The ID of the envelope to void."
      }
    },
    {
      "name": "voidReason",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The reason for voiding the envelope."
      }
    }
  ],
  "output": [
    {
      "name": "success",
      "type": "Boolean",
      "selector": ["success"],
      "meta": {
        "description": "Indicates whether the envelope was successfully voided."
      }
    },
    {
      "name": "status",
      "type": "String",
      "selector": ["status"],
      "meta": {
        "description": "The status of the void operation."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "PUT",
        "path": {
          "value": "/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}",
          "placeholders": [
            {
              "name": "accountId",
              "type": "String",
              "description": "The DocuSign account ID.",
              "required": true
            },
            {
              "name": "envelopeId",
              "type": "String",
              "description": "The ID of the envelope to void.",
              "required": true
            }
          ]
        },
        "headers": {
          "Content-Type": {
            "value": "application/json"
          }
        },
        "bodyTemplate": {
          "value": "{\"status\": \"voided\", \"voidedReason\": \"{{voidReason}}\"}",
          "placeholders": [
            {
              "name": "voidReason",
              "type": "String",
              "description": "The reason for voiding the envelope.",
              "required": false
            }
          ]
        }
      }
    }
  ]
}