Prepare a pinned workflow document
curl --request POST \
--url https://{workspace}.dekasign.com/api/v1/approval-requests/document-preparations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Dekasign-Environment: <x-dekasign-environment>' \
--data '
{
"workflow_id": "<string>",
"workflow_release_id": "<string>",
"field_key": "<string>",
"sender_values": {},
"expires_in_seconds": 86400
}
'import requests
url = "https://{workspace}.dekasign.com/api/v1/approval-requests/document-preparations"
payload = {
"workflow_id": "<string>",
"workflow_release_id": "<string>",
"field_key": "<string>",
"sender_values": {},
"expires_in_seconds": 86400
}
headers = {
"X-Dekasign-Environment": "<x-dekasign-environment>",
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Dekasign-Environment': '<x-dekasign-environment>',
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
workflow_id: '<string>',
workflow_release_id: '<string>',
field_key: '<string>',
sender_values: {},
expires_in_seconds: 86400
})
};
fetch('https://{workspace}.dekasign.com/api/v1/approval-requests/document-preparations', 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://{workspace}.dekasign.com/api/v1/approval-requests/document-preparations",
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([
'workflow_id' => '<string>',
'workflow_release_id' => '<string>',
'field_key' => '<string>',
'sender_values' => [
],
'expires_in_seconds' => 86400
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"X-Dekasign-Environment: <x-dekasign-environment>"
],
]);
$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://{workspace}.dekasign.com/api/v1/approval-requests/document-preparations"
payload := strings.NewReader("{\n \"workflow_id\": \"<string>\",\n \"workflow_release_id\": \"<string>\",\n \"field_key\": \"<string>\",\n \"sender_values\": {},\n \"expires_in_seconds\": 86400\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Dekasign-Environment", "<x-dekasign-environment>")
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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://{workspace}.dekasign.com/api/v1/approval-requests/document-preparations")
.header("X-Dekasign-Environment", "<x-dekasign-environment>")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_id\": \"<string>\",\n \"workflow_release_id\": \"<string>\",\n \"field_key\": \"<string>\",\n \"sender_values\": {},\n \"expires_in_seconds\": 86400\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.dekasign.com/api/v1/approval-requests/document-preparations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Dekasign-Environment"] = '<x-dekasign-environment>'
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_id\": \"<string>\",\n \"workflow_release_id\": \"<string>\",\n \"field_key\": \"<string>\",\n \"sender_values\": {},\n \"expires_in_seconds\": 86400\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"prepared_instance_id": "<string>",
"field_key": "<string>",
"name": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"source_sha256": "<string>",
"signing_layout_sha256": "<string>",
"environment": "sandbox",
"signed": false,
"prepared_content": {
"method": "GET",
"url": "<string>"
}
}approval-requests
Prepare a pinned workflow document
Required scope: documents:write. Sandbox and supported Production configurations; app allowlists, mapped requester authority and active paid coverage apply. Production availability is checked per operation.
Prepare a pinned workflow document
curl --request POST \
--url https://{workspace}.dekasign.com/api/v1/approval-requests/document-preparations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Dekasign-Environment: <x-dekasign-environment>' \
--data '
{
"workflow_id": "<string>",
"workflow_release_id": "<string>",
"field_key": "<string>",
"sender_values": {},
"expires_in_seconds": 86400
}
'import requests
url = "https://{workspace}.dekasign.com/api/v1/approval-requests/document-preparations"
payload = {
"workflow_id": "<string>",
"workflow_release_id": "<string>",
"field_key": "<string>",
"sender_values": {},
"expires_in_seconds": 86400
}
headers = {
"X-Dekasign-Environment": "<x-dekasign-environment>",
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Dekasign-Environment': '<x-dekasign-environment>',
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
workflow_id: '<string>',
workflow_release_id: '<string>',
field_key: '<string>',
sender_values: {},
expires_in_seconds: 86400
})
};
fetch('https://{workspace}.dekasign.com/api/v1/approval-requests/document-preparations', 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://{workspace}.dekasign.com/api/v1/approval-requests/document-preparations",
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([
'workflow_id' => '<string>',
'workflow_release_id' => '<string>',
'field_key' => '<string>',
'sender_values' => [
],
'expires_in_seconds' => 86400
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"X-Dekasign-Environment: <x-dekasign-environment>"
],
]);
$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://{workspace}.dekasign.com/api/v1/approval-requests/document-preparations"
payload := strings.NewReader("{\n \"workflow_id\": \"<string>\",\n \"workflow_release_id\": \"<string>\",\n \"field_key\": \"<string>\",\n \"sender_values\": {},\n \"expires_in_seconds\": 86400\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Dekasign-Environment", "<x-dekasign-environment>")
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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://{workspace}.dekasign.com/api/v1/approval-requests/document-preparations")
.header("X-Dekasign-Environment", "<x-dekasign-environment>")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_id\": \"<string>\",\n \"workflow_release_id\": \"<string>\",\n \"field_key\": \"<string>\",\n \"sender_values\": {},\n \"expires_in_seconds\": 86400\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.dekasign.com/api/v1/approval-requests/document-preparations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Dekasign-Environment"] = '<x-dekasign-environment>'
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_id\": \"<string>\",\n \"workflow_release_id\": \"<string>\",\n \"field_key\": \"<string>\",\n \"sender_values\": {},\n \"expires_in_seconds\": 86400\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"prepared_instance_id": "<string>",
"field_key": "<string>",
"name": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"source_sha256": "<string>",
"signing_layout_sha256": "<string>",
"environment": "sandbox",
"signed": false,
"prepared_content": {
"method": "GET",
"url": "<string>"
}
}Authorizations
SandboxBearerProductionBearer
Headers
Body
application/json
- Option 1
- Option 2
Response
Operation result. Read fields vary by endpoint and deployment; see narrative guide.
