Skip to main content

Void a DocuSign envelope

POST 
/esignature/docusign/:documentId/envelopes/:envelopeId/void

Cancels an in-progress DocuSign envelope; available as an Add-On Module. Requires write access to the selected document or artifact and a matching stored envelope ID. Calls DocuSign's envelope update API, PUT /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}, with status set to voided and the supplied voidedReason. DocuSign notifies recipients that the envelope was voided, including the supplied reason. Only sent or delivered envelopes can be voided. If the envelope is already voided, returns its current state without another update or changing its original reason. Voiding cannot be undone. The existing envelope-voided callback updates the stored FormKiQ status. After a timeout, the outcome is unknown; check the existing GET envelope status endpoint before attempting the operation again.

Request​

Path Parameters

    documentId stringrequired

    Document Identifier

    envelopeId stringrequired

    Docusign Envelope Id

Query Parameters

    siteId string

    Site Identifier

    artifactId string

    Artifact Document Identifier

    environment DocusignEnvironment

    Possible values: [PRODUCTION, DEVELOPMENT]

    DocuSign environment. Defaults to the site's docusignEnvironment; required when the site has no default. Use the environment in which the envelope was created.

Body

required

    voidedReason stringrequired

    Non-blank, recipient-facing explanation for voiding the DocuSign envelope. At most 200 characters, including spaces and line breaks; longer reasons are rejected without truncation.

    Possible values: non-empty and <= 200 characters, Value must match regular expression \S

    Example: Document has been replaced.

Responses​

DocuSign envelope voided successfully

Response Headers

  • Access-Control-Allow-Origin

    string

  • Access-Control-Allow-Methods

    string

  • Access-Control-Allow-Headers

    string

Schema

    envelopeId stringrequired

    Identifier of the DocuSign envelope that was voided

    Example: a1111111-b222-c333-d444-e55555555555
    status stringrequired

    Envelope status after the successful operation, voided

    Example: voided
Loading...