Skip to main content
Prepare a pinned workflow document

Authorizations

Authorization
string
header
required

Sandbox dks_test_ key, server-side only.

Headers

X-Dekasign-Environment
enum<string>
required
Available options:
sandbox,
production
Idempotency-Key
string
required
Required string length: 8 - 160
Pattern: ^[!-~]+$

Body

application/json
workflow_id
string
required
Required string length: 1 - 100
workflow_release_id
string
required
Required string length: 1 - 160
field_key
string
required
Required string length: 1 - 100
sender_values
object
expires_in_seconds
integer
default:86400
Required range: 60 <= x <= 86400

Response

Operation result. Read fields vary by endpoint and deployment; see narrative guide.

id
string
prepared_instance_id
string
field_key
string
name
string
expires_at
string<date-time>
source_sha256
string
Pattern: ^[a-f0-9]{64}$
signing_layout_sha256
string
Pattern: ^[a-f0-9]{64}$
environment
enum<string>
Available options:
sandbox,
production
signed
enum<boolean>
Available options:
false
prepared_content
object