Remind Envelope

POST/openapi/v1/envelopes/remind

Send reminder email notifications to signers who have not yet completed signing.

Target filtering rules:

When both RecipientIds and RecipientEmails are provided, RecipientIds takes precedence and RecipientEmails is ignored;
When only RecipientEmails is provided, the server resolves emails to corresponding recipient IDs using envelope details. Emails that cannot be matched (including those matching carbon-copy recipients) are returned as itemized failures.

Signing order semantics:

Ordered signing (sequential / mixed): If both RecipientIds and RecipientEmails are empty, all signers in the current first batch are reminded. Recipients hitting non-first batch are returned as itemized failures.
Unordered signing (parallel): At least one of RecipientIds or RecipientEmails is required, otherwise the API returns an error.

Other constraints:

Carbon-copy recipients cannot be reminded. Providing their ID or Email will be returned as itemized failures;
Once a signer reaches the maximum successful reminder count, subsequent reminders are returned as itemized failures;
When the API succeeds overall (Response.Error is empty), itemized results are returned via Response.Data.RecipientResults, including both success and failure details.

Request Parameters

Header Parameters

AuthorizationRequiredstring

Bearer <access_token>

X-Operator-User-IdOptionalstring

Operator user ID. Not required in authorization_code mode (uses authorized user automatically); optional in client_credentials mode, falls back to system user ID if omitted.

Request Body

application/json

EnvelopeIdRequiredstring

Envelope ID (required)

RecipientIdsOptionalarray<string>

Signer IDs to remind (optional). - Unordered signing (parallel): At least one of `RecipientIds` or `RecipientEmails` is required. Only matched signers are notified; - Ordered signing (sequential / mixed): Optional. When empty, all signers in the current first batch are reminded. When non-empty, only recipients hitting the current first batch are reminded; the rest are returned as itemized failures. Carbon-copy recipients cannot be reminded. Providing their IDs will be returned as itemized failures.

RecipientEmailsOptionalarray<string>

Signer emails to remind (optional, complementary to `RecipientIds`). Merge rule: When both `RecipientIds` and `RecipientEmails` are provided, `RecipientIds` takes precedence and `RecipientEmails` is ignored. Only when `RecipientIds` is empty and `RecipientEmails` is non-empty are emails resolved to corresponding signers. When an email cannot be matched to a signer in the envelope, it is returned as an itemized failure (`FailureReason=recipient_not_found`). Emails of carbon-copy recipients are also resolved and returned as itemized failures.

Request Example

{
  "EnvelopeId": "SGEV1234567890",
  "RecipientIds": [
    "SGRC0000000001"
  ]
}

Response Parameters

Response.Data

EnvelopeIdOptionalstring

Envelope ID

RecipientResultsOptionalarray<object>

Per-signer reminder results (itemized, including both success and failure details)

⌃Sub-properties

RecipientIdOptionalstring

Signer ID

NameOptionalstring

Signer name

EmailOptionalstring

Signer email (masked, e.g. z***@example.com)

StatusOptionalstring

Current status of the signer

createdsentdeliveredviewedsigneddeclinedvoided

SuccessOptionalboolean

Whether the reminder notification was sent successfully

FailureReasonOptionalstring

Failure reason (present when `Success=false`). Common values: - `not_first_batch`: Not in the current first batch; - `recipient_not_found`: Signer does not exist (including unmatched emails); - `already_signed`: Already signed; - `remind_limit_exceeded`: Reminder count limit reached; - `not_signer_type`: Not a signer (e.g. carbon-copy recipient).

EmailsSentOptionalinteger(int32)

Number of reminder emails sent successfully

NotificationsFailedOptionalinteger(int32)

Number of notifications that failed to send (invalid ID / not first batch / reminder limit reached / mail failure, etc.)

Response Example

{
  "Response": {
    "RequestId": "req-abc123",
    "Error": null,
    "Data": {
      "EnvelopeId": "SGEV1234567890",
      "RecipientResults": [
        {
          "RecipientId": "SGRC0000000001",
          "Name": "John",
          "Email": "j***@example.com",
          "Status": "sent",
          "Success": true
        }
      ],
      "EmailsSent": 1,
      "NotificationsFailed": 0
    }
  }
}

Error Codes

Error Code	Description
`INVALID_REQUEST`	Invalid parameters (e.g. EnvelopeId is empty, or no target provided for unordered signing)
`OPENAPI.OPERATOR_USER_NOT_FOUND`	Operator is not a member of this space
`NOT_FOUND`	Envelope does not exist
`FORBIDDEN`	Operator is neither the envelope creator nor a space admin
`INTERNAL_ERROR`	Internal service error

Cancel Envelope Get Signing Report Download URL