---
updatedAt: 2026-04-29T12:20:04.000Z
agentTools:
  projectIndex: https://developers.signwell.com/llms.txt
---

# Send Reminder

Sends a reminder to recipients who have not signed yet. Each recipient is reminded through their delivery method (email, SMS, or both). SMS reminders are only sent to recipients whose delivery method includes SMS, and only when the workspace is eligible for SMS and has it enabled.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "SignWell Developer API",
    "description": "API for creating, managing, and tracking electronic signature workflows.",
    "version": "v1",
    "termsOfService": "https://www.signwell.com/terms/",
    "contact": {
      "email": "support@signwell.com"
    }
  },
  "tags": [
    {
      "name": "Document",
      "description": "Create, send, and manage documents for electronic signing."
    }
  ],
  "paths": {
    "/api/v1/documents/{id}/remind": {
      "post": {
        "summary": "Send Reminder",
        "description": "Sends a reminder to recipients who have not signed yet. Each recipient is reminded through their delivery method (email, SMS, or both). SMS reminders are only sent to recipients whose delivery method includes SMS, and only when the workspace is eligible for SMS and has it enabled.",
        "tags": [
          "Document"
        ],
        "security": [
          {
            "api_key": []
          }
        ],
        "operationId": "sendReminder",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "$ref": "#/components/schemas/DocumentId"
            },
            "required": true
          }
        ],
        "responses": {
          "201": {
            "description": "created",
            "content": {
              "application/json": {
                "example": {
                  "id": "b58e25b8-a20f-4b06-b6b9-18b7993b33ea",
                  "archived": false,
                  "created_at": "2026-09-29T15:21:50Z",
                  "decline_message": null,
                  "embedded_edit_url": null,
                  "error_message": null,
                  "embedded_preview_url": "https://www.signwell.com/preview/document/b58e25b8-a20f-4b06-b6b9-18b7993b33ea/",
                  "language": "en",
                  "name": "vegetarian-twilight/dolor.ods",
                  "requester_email_address": "jr_morty_52@cummerata.example",
                  "status": "Sent",
                  "test_mode": false,
                  "updated_at": "2026-09-29T15:21:50Z",
                  "cfr_part11": false,
                  "cfr_part11_signing_mode": null,
                  "allow_decline": false,
                  "allow_reassign": true,
                  "api_application_id": null,
                  "custom_requester_email": "lane@goodwin.example",
                  "custom_requester_name": "Rune Haako",
                  "decline_redirect_url": "http://schuster.example/bennie_auer",
                  "embedded_signing": false,
                  "expires_in": 10,
                  "metadata": {
                    "dolores": "deserunt",
                    "necessitatibus": "ipsam"
                  },
                  "redirect_url": "http://wintheiser-adams.example/bruno_little",
                  "reminders": false,
                  "embedded": null,
                  "apply_signing_order": false,
                  "message": "<p>Hey there,</p><p>&nbsp;</p><p>Please review and complete this document. You can click on the document below to get started.</p>",
                  "subject": "Please complete vegetarian-twilight/dolor.ods",
                  "labels": [
                    {
                      "id": "a3ace7dd-1ea7-4b35-9234-fa19f692abd7",
                      "name": "Wilbur Feest"
                    },
                    {
                      "id": "b93e1b81-540c-4e1f-ae06-e39f289b0d16",
                      "name": "Milan Roob"
                    }
                  ],
                  "fields": [
                    [
                      {
                        "api_id": "CheckBox_41",
                        "height": "13.0",
                        "page": 1,
                        "required": true,
                        "type": "checkbox",
                        "value": null,
                        "width": "13.0",
                        "x": 1.1,
                        "y": 1.1,
                        "name": null,
                        "recipient_id": null,
                        "signing_elements_group_id": "bcf5889e-113c-45c3-afd3-0e0325138797"
                      },
                      {
                        "api_id": "CheckBox_42",
                        "height": "13.0",
                        "page": 1,
                        "required": true,
                        "type": "checkbox",
                        "value": null,
                        "width": "13.0",
                        "x": 1.1,
                        "y": 1.1,
                        "name": null,
                        "recipient_id": null
                      },
                      {
                        "api_id": "Signature_40",
                        "height": "32.0",
                        "page": 1,
                        "required": true,
                        "type": "signature",
                        "value": null,
                        "width": "112.0",
                        "x": 1.1,
                        "y": 1.1,
                        "recipient_id": "dde32e2c-8f11-4593-93e9-4b0c3d95fca6"
                      }
                    ]
                  ],
                  "files": [
                    {
                      "name": "laudantium.xlsx",
                      "pages_number": 1
                    }
                  ],
                  "copied_contacts": [
                    {
                      "name": "Odell Buckridge",
                      "email": "angelo@mraz.example"
                    }
                  ],
                  "recipients": [
                    {
                      "delivery_method": "email",
                      "email": "almeta@dietrich.test",
                      "id": "dde32e2c-8f11-4593-93e9-4b0c3d95fca6",
                      "message": null,
                      "name": "Tyesha Smitham",
                      "passcode": null,
                      "send_email": null,
                      "send_email_delay": null,
                      "status": null,
                      "subject": null,
                      "signing_order": 40,
                      "signing_url": "https://www.signwell.com/docs/5c6ac39ea6/",
                      "bounced": null,
                      "bounced_details": null,
                      "passcode_delivery": {
                        "enabled": false,
                        "methods": null,
                        "expire_after_access": false
                      },
                      "attachment_requests": [
                        {
                          "name": "marine_vegetarian/provident.tiff",
                          "required": true,
                          "url": "https://www.signwell.com/document_attachments/7alyA5DyjBtrdZXO3yoPIZLaPNz/?access=22ee52e6-05c2-45a3-b593-7c8637555edd"
                        }
                      ]
                    },
                    {
                      "delivery_method": "email",
                      "email": "jeri.leannon@windler.example",
                      "id": "55b16e47-1945-4e77-8bff-c3e2b692f352",
                      "message": null,
                      "name": "Sen. Katharina Koelpin",
                      "passcode": null,
                      "send_email": null,
                      "send_email_delay": null,
                      "status": null,
                      "subject": null,
                      "signing_order": 41,
                      "signing_url": "https://www.signwell.com/docs/dc03d7ab6a/",
                      "bounced": null,
                      "bounced_details": null,
                      "passcode_delivery": {
                        "enabled": false,
                        "methods": null,
                        "expire_after_access": false
                      },
                      "attachment_requests": []
                    }
                  ],
                  "checkbox_groups": [
                    {
                      "id": "bcf5889e-113c-45c3-afd3-0e0325138797",
                      "group_name": null,
                      "recipient_id": null,
                      "checkbox_ids": [
                        "CheckBox_41"
                      ],
                      "validation": null,
                      "required": false
                    }
                  ],
                  "conditional_rules": [],
                  "conditional_logic_decisions": []
                }
              }
            }
          },
          "404": {
            "description": "not found",
            "content": {
              "application/json": {
                "example": {
                  "message": "Not found",
                  "meta": {
                    "error": "record_not_found",
                    "message": "Couldn't find the document requested",
                    "messages": [
                      "Couldn't find the document requested"
                    ]
                  }
                },
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "unprocessable entity",
            "content": {
              "application/json": {
                "example": {
                  "errors": {
                    "document": "The document is in a status that cannot be reminded"
                  }
                },
                "schema": {
                  "$ref": "#/components/schemas/ValidationErrorResponse"
                }
              }
            }
          },
          "429": {
            "description": "rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RateLimitErrorResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SendReminderRequest"
              }
            }
          },
          "required": true
        },
        "x-readme": {
          "code-samples": [
            {
              "language": "ruby",
              "name": "Ruby SDK",
              "install": "gem install signwell_sdk",
              "code": "require 'signwell_sdk'\n\nSignWell.configure do |config|\n  config.api_key['X-Api-Key'] = ENV['SIGNWELL_API_KEY']\nend\n\napi = SignWell::Resources::DocumentApi.new\n\n# Reminds all recipients that have not signed yet\napi.send_reminder('document_id', SignWell::Models::SendReminderRequest.new)\n\n# Or remind specific recipients only\nrequest = SignWell::Models::SendReminderRequest.new(\n  recipients: [\n    SignWell::Models::ReminderRecipientsInner.new(email: 'jane@example.com')\n  ]\n)\napi.send_reminder('document_id', request)"
            }
          ]
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "X-Api-Key",
        "in": "header"
      }
    },
    "schemas": {
      "DocumentId": {
        "type": "string",
        "format": "uuid",
        "description": "Unique identifier for a document."
      },
      "ReminderRecipients": {
        "type": "array",
        "description": "Optional list of recipients within the document to remind. If none are specified, all recipients that have not signed yet are reminded. Each recipient is reminded through their own delivery method: email-only recipients get a reminder email, SMS-only recipients get a reminder text, and email_and_sms recipients get both. If the workspace has insufficient SMS credit, only the SMS reminder is skipped and the sender is notified once; the email reminder (if applicable) still goes out.",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "Recipient's name (required if multiple recipients share the same email)."
            },
            "email": {
              "type": "string",
              "format": "email",
              "description": "Recipient's email address. Used to match the recipient to remind; not required for SMS-only recipients, who can be identified by name instead."
            }
          }
        }
      },
      "SendReminderRequest": {
        "type": "object",
        "properties": {
          "recipients": {
            "$ref": "#/components/schemas/ReminderRecipients"
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "description": "Standard error response",
        "properties": {
          "message": {
            "type": "string",
            "description": "Human-readable error message"
          },
          "meta": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "description": "Error code identifier"
              },
              "message": {
                "type": "string",
                "description": "Detailed error message"
              },
              "messages": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "List of error messages"
              }
            },
            "required": [
              "error",
              "message"
            ]
          }
        }
      },
      "ValidationErrorResponse": {
        "type": "object",
        "description": "Validation error response. The errors object contains field-specific error details with dynamic keys.",
        "properties": {
          "errors": {
            "type": "object",
            "additionalProperties": true,
            "description": "Field-specific validation errors. Keys are field names (e.g., recipients, fields, files). Values can be strings, arrays of strings, or nested objects with further field-specific errors."
          }
        },
        "required": [
          "errors"
        ]
      },
      "RateLimitErrorResponse": {
        "type": "object",
        "description": "Rate limit exceeded error response (HTTP 429)",
        "properties": {
          "error": {
            "type": "string",
            "description": "Rate limit error message indicating the limit and reset time"
          }
        },
        "required": [
          "error"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://www.signwell.com"
    }
  ]
}
```