Skip to main content
POST
/
sign
/
envelopes
/
{envelopeID}
:send-reminders
Send Reminders for Envelope
curl --request POST \
  --url https://api.gonitro.dev/sign/envelopes/{envelopeID}:send-reminders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "notification": {
    "subject": "<string>",
    "body": "<string>"
  }
}
'
This response does not have an example.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
envelopeID
string<uuid>
required

A unique UUIDv4 string that identifies the envelope in the Nitro system.

Body

application/json
​
notification
object

The notification object defines the reminder notifications sent to pending participants. It contains a subject and a body as nested parameters, and both fields support dynamic variables.

Dynamic Variables You can personalize notification emails by referencing dynamic variables in the subject or body. Available variables: envelope_name: The name of the envelope being signed. sender_name_or_email: The sender’s name, or their email address if the name is not available.

Syntax: To reference the variables, wrap them with $() in your message. Example: $(envelope_name)

notification object example:

{
    "notification": {
        "subject": "$(sender_name_or_email) is requesting your signature",
        "body": "Hi,\nPlease sign the $(envelope_name)\nThank you,\n$(sender_name_or_email)"
    }
}

Note: If the notification object is not provided in the request (or an empty object {} is sent), reminder emails will be sent using the default notification template that was configured when the envelope was created.

Response

Reminders triggered successfully