Skip to main content
POST
signature.request.send-template

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
ref
string
required

The ref returned by signature.template.create or a row of signature.templates.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
signers
object[]
required

Names, emails and template roles to fill.

Required array length: 1 - 20 elements
title
string

Agreement title.

Required string length: 1 - 100
subject
string

Email subject.

Required string length: 1 - 100
message
string

Message for signers.

Required string length: 1 - 5000
values
object[]

Named text values; unsupported or ambiguous fields are refused.

Maximum array length: 200
delivery
enum<string>
default:email

Email reaches the signers. Embedded delivery needs a supported signing session.

Available options:
email,
embedded
testMode
boolean
default:false

Real signing requests only.

Response

The result

status
enum<string>
required

Submission accepted; does not wait for signatures.

Available options:
preparing,
sent
delivery
enum<string>
required

How the signers receive the request.

Available options:
email,
embedded
ref
string

Reference to what this call created. Pass it as ref to signature.request.get, signature.request.cancel, signature.request.download.