Skip to main content
POST
/
signature_request
/
send-from-template
Send Signature Request from Template
curl --request POST \
  --url https://api.luminpdf.com/v1/signature_request/send-from-template \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "template_id": "<string>",
  "title": "<string>",
  "signers": [
    {
      "email_address": "<string>",
      "name": "<string>",
      "signer_role": "<string>",
      "verification": {
        "payload": {
          "claims": []
        }
      }
    }
  ],
  "expires_at": 123,
  "tags": {},
  "fields": {},
  "variables": {},
  "viewers": [
    {
      "email_address": "<string>",
      "name": "<string>"
    }
  ],
  "custom_email": {
    "sender_email": "<string>",
    "subject_name": "<string>",
    "title": "<string>"
  }
}
'
{
  "signature_request": {
    "signature_request_id": "<string>",
    "created_at": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.luminpdf.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

Body

application/json
template_id
string
required

ID of the template. ID needs to include the prefix returned by the template list endpoint.

title
string
required

The title of the signature request.

Required string length: 1 - 255
signers
object[]
required

Signers of the signature request.

expires_at
integer<unix-epoch>
required

When the signature request will expire. This is a unix epoch timestamp (miliseconds). Should be later than today.

tags
object

Key–value pairs for Merge Tags defined in the Sign template. Keys must match tag names. Values replace the corresponding tags and are rendered as plain text in the sent agreement.

fields
object

Key–value pairs for Form Fields defined in the template. Keys must match field names. Values prefill the corresponding fields in the sent agreement.

variables
object

Key–value pairs for Variables defined in the AgreementGen template. Keys must match variable names. Values prefill the corresponding variables and are rendered as plain text in the sent agreement.

viewers
object[]

Viewers of the signature request.

custom_email
object

Custom email content for the email sent to signers.

Response

Returns the information of the created signature request.

signature_request
object
required

Contains information about a signature request.