Send Reminder Emails

curl --request POST \
  --url https://api.luminpdf.com/v1/signature_request/remind/{signature_request_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "emails": [
    "[email protected]",
    "[email protected]"
  ]
}
'

import requests

url = "https://api.luminpdf.com/v1/signature_request/remind/{signature_request_id}"

payload = { "emails": ["[email protected]", "[email protected]"] }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({emails: ['[email protected]', '[email protected]']})
};

fetch('https://api.luminpdf.com/v1/signature_request/remind/{signature_request_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.luminpdf.com/v1/signature_request/remind/{signature_request_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'emails' => [
        '[email protected]',
        '[email protected]'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.luminpdf.com/v1/signature_request/remind/{signature_request_id}"

	payload := strings.NewReader("{\n  \"emails\": [\n    \"[email protected]\",\n    \"[email protected]\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.luminpdf.com/v1/signature_request/remind/{signature_request_id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"emails\": [\n    \"[email protected]\",\n    \"[email protected]\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.luminpdf.com/v1/signature_request/remind/{signature_request_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"emails\": [\n    \"[email protected]\",\n    \"[email protected]\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "signature_request": {
    "signature_request_id": "696d007913f3b8...",
    "title": "Signature request",
    "created_at": 1768751225657,
    "expires_at": 1927510980694,
    "status": "WAITING_FOR_OTHERS",
    "signers": [
      {
        "name": "John Doe",
        "email_address": "[email protected]",
        "status": "WAITING_FOR_OTHERS",
        "is_approved": true,
        "group": 1
      },
      {
        "name": "Jane Doe",
        "email_address": "[email protected]",
        "status": "NEED_TO_SIGN",
        "is_approved": false,
        "group": 2
      }
    ],
    "updated_at": 1768751357064,
    "details_url": "https://sign.luminpdf.com/auth?mode=view-contract&token=8647b08b...",
    "signing_type": "ORDER"
  },
  "reminders": [
    {
      "email": "[email protected]",
      "signer_status": "WAITING_FOR_OTHERS",
      "email_status": "BOUNCE"
    },
    {
      "email": "[email protected]",
      "signer_status": "NEED_TO_SIGN",
      "email_status": "SENT"
    }
  ]
}

{
  "error_code": "<string>",
  "error_message": "<string>"
}

POST

signature_request

remind

{signature_request_id}

Send Reminder Emails

curl --request POST \
  --url https://api.luminpdf.com/v1/signature_request/remind/{signature_request_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "emails": [
    "[email protected]",
    "[email protected]"
  ]
}
'

import requests

url = "https://api.luminpdf.com/v1/signature_request/remind/{signature_request_id}"

payload = { "emails": ["[email protected]", "[email protected]"] }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({emails: ['[email protected]', '[email protected]']})
};

fetch('https://api.luminpdf.com/v1/signature_request/remind/{signature_request_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.luminpdf.com/v1/signature_request/remind/{signature_request_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'emails' => [
        '[email protected]',
        '[email protected]'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.luminpdf.com/v1/signature_request/remind/{signature_request_id}"

	payload := strings.NewReader("{\n  \"emails\": [\n    \"[email protected]\",\n    \"[email protected]\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.luminpdf.com/v1/signature_request/remind/{signature_request_id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"emails\": [\n    \"[email protected]\",\n    \"[email protected]\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.luminpdf.com/v1/signature_request/remind/{signature_request_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"emails\": [\n    \"[email protected]\",\n    \"[email protected]\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "signature_request": {
    "signature_request_id": "696d007913f3b8...",
    "title": "Signature request",
    "created_at": 1768751225657,
    "expires_at": 1927510980694,
    "status": "WAITING_FOR_OTHERS",
    "signers": [
      {
        "name": "John Doe",
        "email_address": "[email protected]",
        "status": "WAITING_FOR_OTHERS",
        "is_approved": true,
        "group": 1
      },
      {
        "name": "Jane Doe",
        "email_address": "[email protected]",
        "status": "NEED_TO_SIGN",
        "is_approved": false,
        "group": 2
      }
    ],
    "updated_at": 1768751357064,
    "details_url": "https://sign.luminpdf.com/auth?mode=view-contract&token=8647b08b...",
    "signing_type": "ORDER"
  },
  "reminders": [
    {
      "email": "[email protected]",
      "signer_status": "WAITING_FOR_OTHERS",
      "email_status": "BOUNCE"
    },
    {
      "email": "[email protected]",
      "signer_status": "NEED_TO_SIGN",
      "email_status": "SENT"
    }
  ]
}

{
  "error_code": "<string>",
  "error_message": "<string>"
}

Required scopes (OAuth 2.0)

This endpoint requires the following scope:sign:requests

Authorizations

X-API-Key

string

header

required

Provide your API key in the X-API-Key header, e.g., X-API-Key: YOUR_API_KEY.

Path Parameters

signature_request_id

string

required

ID of the signature request

Body

application/json

emails

string<email>[]

required

List of emails to send reminder.

Response

Returns signature request details and per-email reminder results.

signature_request

object

required

Contains information about a signature request.

Hide child attributes

signature_request.signature_request_id

string

required

The unique identifier for the signature request.

signature_request.title

string

required

The title of the signature request.

signature_request.created_at

string

required

The time the signature request was created.

signature_request.expires_at

string

required

The time the signature request will expire.

signature_request.details_url

string

required

The url to view the signature request in the browser.

signature_request.status

enum<string>

required

The status of the signature request.

Available options:

NEED_TO_SIGN,

WAITING_FOR_OTHERS,

APPROVED,

REJECTED,

WAITING_FOR_PROCESSING,

FAILED,

CANCELLED

signature_request.signing_type

enum<string>

required

Recipient signing flow.

Available options:

SAME_TIME,

ORDER

signature_request.signers

object[]

required

The signers of the signature request.

Hide child attributes

signature_request.signers.email_address

string

Email address of the signer.

signature_request.signers.name

string

Name of the signer.

signature_request.signers.group

number

The signing order of signer for the signature request with signing_type is ORDER. Required if signing_type is ORDER.

Only signers in 1st Signers group will receive email/notification, signers in subsequent groups will receive email/notification when all signers in previous group has signed.

Group starts incrementing at 1.

The default value for group always is 1 if signing_type is SAME_TIME.

signature_request.signers.is_approved

boolean

Whether the signer has approved the signature request.

signature_request.signers.status

enum<string>

The status of the Signer.

Available options:

NEED_TO_SIGN,

APPROVED,

WAITING_FOR_OTHERS,

REJECTED,

FAILED,

WAITING_FOR_PROCESSING

signature_request.updated_at

string

The time the signature request was last updated.

signature_request.reason

string

The reason for the status FAILED or REJECTED of the signature request.

reminders

object[]

required

List of reminder email results for requested signer emails.

Hide child attributes

reminders.email

string<email>

required

The signer email that the reminder request targets.

reminders.signer_status

enum<string>

required

The signer status at the time of sending the reminder. One of: NEED_TO_SIGN, APPROVED, REJECTED, WAITING_FOR_OTHERS

Available options:

NEED_TO_SIGN,

APPROVED,

REJECTED,

WAITING_FOR_OTHERS

reminders.email_status

enum<string>

required

Result of reminder email delivery attempt.

SENT – Sent an email successfully
EXCEED_DAILY_LIMIT – Email not sent due to daily limit (10 emails/signer/day)
BOUNCE – Email not sent because the signer already signed or is not in turn to sign

Available options:

SENT,

EXCEED_DAILY_LIMIT,

BOUNCE

Create Signing Session

Cancel Signature Request

API Documentation

Lumin API reference

Send Reminder Emails

Authorizations

Path Parameters

Body

Response