POST /public/v1/documents/{document_id}/send-reminder

Sends manual reminders to one or more recipients of a specified document.

Servers

Path parameters

Name Type Required Description
document_id String Yes

The UUID of the document.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
reminders[] Array No

A list of reminders to be sent to specified recipients. Use this field to specify which recipients should receive a reminder and through which delivery methods.

Each email reminder contains document sender in the From field, ensuring the recipient always sees consistent sender details and branding.

reminders[].recipient_id String No

Unique identifier of the recipient to receive the reminder.

reminders[].email_customization Object No

Optional customization settings for the reminder email. Defines the subject and body text used when sending the reminder via email. This object is processed only if delivery_methods.email is set to true.

reminders[].email_customization.message String No

Custom message body of the reminder email. Can include friendly or contextual text encouraging the recipient to complete the signing process.

Supports Markdown syntax for rich text formatting (e.g., bold, italics, links, and line breaks).

reminders[].email_customization.subject String No

Subject line of the reminder email sent to the recipient.

reminders[].delivery_methods Object No
reminders[].delivery_methods.email Boolean No
reminders[].delivery_methods.sms Boolean No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.