Request DocuSign signing reminders

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

Resends signing notifications for an in-progress DocuSign envelope; available as an Add-On Module. With no request body or an empty object, DocuSign reminds all eligible recipients at the current routing step. Supply recipientIds to remind only the selected eligible signers. Obtain IDs from recipients.signers[].recipientId in GET /esignature/docusign/{documentId}/envelopes/{envelopeId}. Every selected signer must still be awaiting action at the current routing step when this request is processed. Validate the entire selection before issuing a resend. Completed and future-step signers cannot be targeted. Invalid targeted requests never fall back to reminding all recipients. Recipient notification settings are respected; this operation does not send FormKiQ notifications to embedded-only or email-suppressed signers. Requires write access to the selected document or artifact and a matching stored envelope ID. The operation resends the existing invitation without changing recipients, documents, routing, or automatic reminder settings. Targeted responses report each selected recipient's acceptance or failure, with no overall status. Acceptance does not confirm notification delivery. Do not automatically retry after a timeout because the reminder may already have been requested.

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.

application/json

Body

recipientIds string[]
Existing DocuSign signer IDs from recipients.signers[].recipientId in GET /esignature/docusign/{documentId}/envelopes/{envelopeId} for this same envelope. Every selected signer must be notification-eligible and awaiting action at the current routing step. Validate the entire selection before issuing a resend. Null or empty arrays, duplicate IDs, and null, empty, whitespace-only, or non-string entries are invalid. Omit this property for an envelope-level reminder.
Possible values: >= 1
Example: ["2","3"]

Responses

200

Reminder request processed. For targeted requests, inspect each entry in recipients for acceptance or failure; HTTP 200 does not mean all selected recipients succeeded. An envelope-wide request returns an empty object when DocuSign accepts it, because individual recipient outcomes are not returned. Acceptance does not confirm delivery.

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

recipients

object[]

Outcomes for the selected recipients, present for targeted requests and omitted for envelope-wide reminders. A timeout or missing provider outcome must not be represented as confirmed acceptance or failure.

Possible values: >= 1

Array [

recipientId stringrequired

Selected DocuSign signer ID from the request

Example: 1

status stringrequired

accepted means DocuSign accepted the reminder request for this recipient, not confirmed delivery. failed means DocuSign returned a definitive recipient-level failure.

Example: accepted

message string

Explanation of a recipient-level failure, when available

Example: Recipient is no longer eligible for a reminder.

]

Example (from schema)

{
  "recipients": [
    {
      "recipientId": "1",
      "status": "accepted",
      "message": "Recipient is no longer eligible for a reminder."
    }
  ]
}

selectedRecipients

One reminder accepted and one failed after validation

{
  "recipients": [
    {
      "recipientId": "1",
      "status": "accepted"
    },
    {
      "recipientId": "2",
      "status": "failed",
      "message": "Recipient is no longer eligible for a reminder."
    }
  ]
}

envelopeWide

Envelope-wide reminder accepted without individual outcomes

{}

400

Invalid parameters, missing DocuSign configuration, ineligible envelope state, or unknown or ineligible signers. Null or empty recipientIds arrays, duplicate IDs, and null, blank, or non-string entries are rejected. The singular recipientId field is not accepted. Draft and terminal envelopes cannot be reminded.

application/json

Schema

Schema

errors

object[]

List of errors

Array [

key string

Error Key

error string

Error Message

]

Example (from schema)

{
  "errors": [
    {
      "key": "string",
      "error": "string"
    }
  ]
}

401

Authentication required

403

Write access to the selected document or artifact is denied

404

Document, artifact, or associated DocuSign envelope not found

429

DocuSign rate limit exceeded

502

DocuSign authentication failure, upstream error, or invalid response

504

DocuSign request timed out; reminder delivery outcome is unknown

Loading...