Update Signature Request

curl --request PATCH \
  --url https://api.luminpdf.com/v1/signature_request/{signature_request_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "expires_at": 1927510980000
}
'

import requests

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

payload = { "expires_at": 1927510980000 }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({expires_at: 1927510980000})
};

fetch('https://api.luminpdf.com/v1/signature_request/{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/{signature_request_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'expires_at' => 1927510980000
  ]),
  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/{signature_request_id}"

	payload := strings.NewReader("{\n  \"expires_at\": 1927510980000\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.luminpdf.com/v1/signature_request/{signature_request_id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expires_at\": 1927510980000\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

{
  "signature_request": {
    "signature_request_id": "1234567890",
    "title": "Title Here",
    "created_at": 1756887739247,
    "expires_at": 1927510980000,
    "status": "WAITING_FOR_OTHERS"
  }
}

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

PATCH

signature_request

{signature_request_id}

Update Signature Request

curl --request PATCH \
  --url https://api.luminpdf.com/v1/signature_request/{signature_request_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "expires_at": 1927510980000
}
'

import requests

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

payload = { "expires_at": 1927510980000 }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({expires_at: 1927510980000})
};

fetch('https://api.luminpdf.com/v1/signature_request/{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/{signature_request_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'expires_at' => 1927510980000
  ]),
  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/{signature_request_id}"

	payload := strings.NewReader("{\n  \"expires_at\": 1927510980000\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.luminpdf.com/v1/signature_request/{signature_request_id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expires_at\": 1927510980000\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

{
  "signature_request": {
    "signature_request_id": "1234567890",
    "title": "Title Here",
    "created_at": 1756887739247,
    "expires_at": 1927510980000,
    "status": "WAITING_FOR_OTHERS"
  }
}

{
  "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

expires_at

integer<unix-epoch>

required

The expiration time of the signature request, expressed as a Unix epoch timestamp in milliseconds. This value must represent a future point in time.

Response

Returns the updated signature request.

signature_request

object

Signature request details with the updated data.

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.

Get Signature Request

Send Signature Request

API Documentation

Lumin API reference

Update Signature Request

Authorizations

Path Parameters

Body

Response