Update a template
curl --request PATCH \
--url https://my.flowsign.app/api/v1/templates/{templateId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"name": "Employment agreement",
"description": "Standard individual employment agreement for new hires.",
"status": "ACTIVE",
"tags": [
"HR",
"Onboarding"
],
"reminderIntervalDays": 3,
"expirationDays": 30,
"expiryWarningDays": 5,
"emailSubject": "Your employment agreement with Studio Phoenix Limited",
"emailMessage": "Kia ora {{employee_name}}, please review and sign your agreement.",
"signingMode": "SEQUENTIAL",
"brandColor": "#1a2b3c",
"roles": [
{
"name": "Employee",
"order": 0,
"id": "cmg3k2v8a0001s7p4d9x1qz2h",
"actionType": "SIGNER",
"deliveryDefault": "EMAIL",
"hostRole": "SENDER",
"hostUserIds": [
"8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f"
],
"hostGroupIds": [
"cmg1hd3x10002v8p9f6r8bt4n"
]
}
],
"questions": [
{
"question": "Does the role include a company vehicle?",
"order": 0,
"type": "TOGGLE",
"dependsOnQuestionIndex": 0,
"dependsOnOptionIndex": 0,
"options": [
{
"label": "Yes",
"order": 0,
"isDefault": true,
"actions": [
{
"type": "INCLUDE_DOCUMENT",
"targetDocumentId": "cmg3k5r1c0003s7p4h2m8tb7k",
"targetFieldId": "cmg3k7q9e0004s7p4b1z6lc3n"
}
]
}
]
}
],
"metadata": "<unknown>",
"documentConfig": [
{
"documentId": "cmg3k5r1c0003s7p4h2m8tb7k",
"variables": [
{
"ref": "v_3kq9x",
"key": "start_date",
"label": "Start date",
"type": "TEXT",
"source": "SENDER",
"defaultValue": "2026-10-01",
"isRequired": true,
"dropdownOptions": []
}
],
"questions": [
{
"id": "cmg3k9y2h0006s7p4e4k7nq1t",
"question": "Is a company car included?",
"options": [
{
"id": "cmg3k9y2h0007s7p4g8d3rp6v",
"label": "Yes"
}
]
}
]
}
],
"mergeFields": [
{
"key": "start_date",
"label": "Start date",
"order": 0,
"description": "The employee's first day of work.",
"source": "SENDER",
"type": "DATE",
"options": [
"Full time",
"Part time"
],
"defaultValue": "2026-10-01",
"isRequired": true
}
]
}
EOFconst options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Employment agreement',
description: 'Standard individual employment agreement for new hires.',
status: 'ACTIVE',
tags: ['HR', 'Onboarding'],
reminderIntervalDays: 3,
expirationDays: 30,
expiryWarningDays: 5,
emailSubject: 'Your employment agreement with Studio Phoenix Limited',
emailMessage: 'Kia ora {{employee_name}}, please review and sign your agreement.',
signingMode: 'SEQUENTIAL',
brandColor: '#1a2b3c',
roles: [
{
name: 'Employee',
order: 0,
id: 'cmg3k2v8a0001s7p4d9x1qz2h',
actionType: 'SIGNER',
deliveryDefault: 'EMAIL',
hostRole: 'SENDER',
hostUserIds: ['8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f'],
hostGroupIds: ['cmg1hd3x10002v8p9f6r8bt4n']
}
],
questions: [
{
question: 'Does the role include a company vehicle?',
order: 0,
type: 'TOGGLE',
dependsOnQuestionIndex: 0,
dependsOnOptionIndex: 0,
options: [
{
label: 'Yes',
order: 0,
isDefault: true,
actions: [
{
type: 'INCLUDE_DOCUMENT',
targetDocumentId: 'cmg3k5r1c0003s7p4h2m8tb7k',
targetFieldId: 'cmg3k7q9e0004s7p4b1z6lc3n'
}
]
}
]
}
],
metadata: '<unknown>',
documentConfig: [
{
documentId: 'cmg3k5r1c0003s7p4h2m8tb7k',
variables: [
{
ref: 'v_3kq9x',
key: 'start_date',
label: 'Start date',
type: 'TEXT',
source: 'SENDER',
defaultValue: '2026-10-01',
isRequired: true,
dropdownOptions: []
}
],
questions: [
{
id: 'cmg3k9y2h0006s7p4e4k7nq1t',
question: 'Is a company car included?',
options: [{id: 'cmg3k9y2h0007s7p4g8d3rp6v', label: 'Yes'}]
}
]
}
],
mergeFields: [
{
key: 'start_date',
label: 'Start date',
order: 0,
description: 'The employee\'s first day of work.',
source: 'SENDER',
type: 'DATE',
options: ['Full time', 'Part time'],
defaultValue: '2026-10-01',
isRequired: true
}
]
})
};
fetch('https://my.flowsign.app/api/v1/templates/{templateId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Employment agreement',
description: 'Standard individual employment agreement for new hires.',
status: 'ACTIVE',
tags: ['HR', 'Onboarding'],
reminderIntervalDays: 3,
expirationDays: 30,
expiryWarningDays: 5,
emailSubject: 'Your employment agreement with Studio Phoenix Limited',
emailMessage: 'Kia ora {{employee_name}}, please review and sign your agreement.',
signingMode: 'SEQUENTIAL',
brandColor: '#1a2b3c',
roles: [
{
name: 'Employee',
order: 0,
id: 'cmg3k2v8a0001s7p4d9x1qz2h',
actionType: 'SIGNER',
deliveryDefault: 'EMAIL',
hostRole: 'SENDER',
hostUserIds: ['8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f'],
hostGroupIds: ['cmg1hd3x10002v8p9f6r8bt4n']
}
],
questions: [
{
question: 'Does the role include a company vehicle?',
order: 0,
type: 'TOGGLE',
dependsOnQuestionIndex: 0,
dependsOnOptionIndex: 0,
options: [
{
label: 'Yes',
order: 0,
isDefault: true,
actions: [
{
type: 'INCLUDE_DOCUMENT',
targetDocumentId: 'cmg3k5r1c0003s7p4h2m8tb7k',
targetFieldId: 'cmg3k7q9e0004s7p4b1z6lc3n'
}
]
}
]
}
],
metadata: '<unknown>',
documentConfig: [
{
documentId: 'cmg3k5r1c0003s7p4h2m8tb7k',
variables: [
{
ref: 'v_3kq9x',
key: 'start_date',
label: 'Start date',
type: 'TEXT',
source: 'SENDER',
defaultValue: '2026-10-01',
isRequired: true,
dropdownOptions: []
}
],
questions: [
{
id: 'cmg3k9y2h0006s7p4e4k7nq1t',
question: 'Is a company car included?',
options: [{id: 'cmg3k9y2h0007s7p4g8d3rp6v', label: 'Yes'}]
}
]
}
],
mergeFields: [
{
key: 'start_date',
label: 'Start date',
order: 0,
description: 'The employee\'s first day of work.',
source: 'SENDER',
type: 'DATE',
options: ['Full time', 'Part time'],
defaultValue: '2026-10-01',
isRequired: true
}
]
})
};
fetch('https://my.flowsign.app/api/v1/templates/{templateId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://my.flowsign.app/api/v1/templates/{templateId}';
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Employment agreement',
description: 'Standard individual employment agreement for new hires.',
status: 'ACTIVE',
tags: ['HR', 'Onboarding'],
reminderIntervalDays: 3,
expirationDays: 30,
expiryWarningDays: 5,
emailSubject: 'Your employment agreement with Studio Phoenix Limited',
emailMessage: 'Kia ora {{employee_name}}, please review and sign your agreement.',
signingMode: 'SEQUENTIAL',
brandColor: '#1a2b3c',
roles: [
{
name: 'Employee',
order: 0,
id: 'cmg3k2v8a0001s7p4d9x1qz2h',
actionType: 'SIGNER',
deliveryDefault: 'EMAIL',
hostRole: 'SENDER',
hostUserIds: ['8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f'],
hostGroupIds: ['cmg1hd3x10002v8p9f6r8bt4n']
}
],
questions: [
{
question: 'Does the role include a company vehicle?',
order: 0,
type: 'TOGGLE',
dependsOnQuestionIndex: 0,
dependsOnOptionIndex: 0,
options: [
{
label: 'Yes',
order: 0,
isDefault: true,
actions: [
{
type: 'INCLUDE_DOCUMENT',
targetDocumentId: 'cmg3k5r1c0003s7p4h2m8tb7k',
targetFieldId: 'cmg3k7q9e0004s7p4b1z6lc3n'
}
]
}
]
}
],
metadata: '<unknown>',
documentConfig: [
{
documentId: 'cmg3k5r1c0003s7p4h2m8tb7k',
variables: [
{
ref: 'v_3kq9x',
key: 'start_date',
label: 'Start date',
type: 'TEXT',
source: 'SENDER',
defaultValue: '2026-10-01',
isRequired: true,
dropdownOptions: []
}
],
questions: [
{
id: 'cmg3k9y2h0006s7p4e4k7nq1t',
question: 'Is a company car included?',
options: [{id: 'cmg3k9y2h0007s7p4g8d3rp6v', label: 'Yes'}]
}
]
}
],
mergeFields: [
{
key: 'start_date',
label: 'Start date',
order: 0,
description: 'The employee\'s first day of work.',
source: 'SENDER',
type: 'DATE',
options: ['Full time', 'Part time'],
defaultValue: '2026-10-01',
isRequired: true
}
]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://my.flowsign.app/api/v1/templates/{templateId}"
payload = {
"name": "Employment agreement",
"description": "Standard individual employment agreement for new hires.",
"status": "ACTIVE",
"tags": ["HR", "Onboarding"],
"reminderIntervalDays": 3,
"expirationDays": 30,
"expiryWarningDays": 5,
"emailSubject": "Your employment agreement with Studio Phoenix Limited",
"emailMessage": "Kia ora {{employee_name}}, please review and sign your agreement.",
"signingMode": "SEQUENTIAL",
"brandColor": "#1a2b3c",
"roles": [
{
"name": "Employee",
"order": 0,
"id": "cmg3k2v8a0001s7p4d9x1qz2h",
"actionType": "SIGNER",
"deliveryDefault": "EMAIL",
"hostRole": "SENDER",
"hostUserIds": ["8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f"],
"hostGroupIds": ["cmg1hd3x10002v8p9f6r8bt4n"]
}
],
"questions": [
{
"question": "Does the role include a company vehicle?",
"order": 0,
"type": "TOGGLE",
"dependsOnQuestionIndex": 0,
"dependsOnOptionIndex": 0,
"options": [
{
"label": "Yes",
"order": 0,
"isDefault": True,
"actions": [
{
"type": "INCLUDE_DOCUMENT",
"targetDocumentId": "cmg3k5r1c0003s7p4h2m8tb7k",
"targetFieldId": "cmg3k7q9e0004s7p4b1z6lc3n"
}
]
}
]
}
],
"metadata": "<unknown>",
"documentConfig": [
{
"documentId": "cmg3k5r1c0003s7p4h2m8tb7k",
"variables": [
{
"ref": "v_3kq9x",
"key": "start_date",
"label": "Start date",
"type": "TEXT",
"source": "SENDER",
"defaultValue": "2026-10-01",
"isRequired": True,
"dropdownOptions": []
}
],
"questions": [
{
"id": "cmg3k9y2h0006s7p4e4k7nq1t",
"question": "Is a company car included?",
"options": [
{
"id": "cmg3k9y2h0007s7p4g8d3rp6v",
"label": "Yes"
}
]
}
]
}
],
"mergeFields": [
{
"key": "start_date",
"label": "Start date",
"order": 0,
"description": "The employee's first day of work.",
"source": "SENDER",
"type": "DATE",
"options": ["Full time", "Part time"],
"defaultValue": "2026-10-01",
"isRequired": True
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://my.flowsign.app/api/v1/templates/{templateId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"name\": \"Employment agreement\",\n \"description\": \"Standard individual employment agreement for new hires.\",\n \"status\": \"ACTIVE\",\n \"tags\": [\n \"HR\",\n \"Onboarding\"\n ],\n \"reminderIntervalDays\": 3,\n \"expirationDays\": 30,\n \"expiryWarningDays\": 5,\n \"emailSubject\": \"Your employment agreement with Studio Phoenix Limited\",\n \"emailMessage\": \"Kia ora {{employee_name}}, please review and sign your agreement.\",\n \"signingMode\": \"SEQUENTIAL\",\n \"brandColor\": \"#1a2b3c\",\n \"roles\": [\n {\n \"name\": \"Employee\",\n \"order\": 0,\n \"id\": \"cmg3k2v8a0001s7p4d9x1qz2h\",\n \"actionType\": \"SIGNER\",\n \"deliveryDefault\": \"EMAIL\",\n \"hostRole\": \"SENDER\",\n \"hostUserIds\": [\n \"8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f\"\n ],\n \"hostGroupIds\": [\n \"cmg1hd3x10002v8p9f6r8bt4n\"\n ]\n }\n ],\n \"questions\": [\n {\n \"question\": \"Does the role include a company vehicle?\",\n \"order\": 0,\n \"type\": \"TOGGLE\",\n \"dependsOnQuestionIndex\": 0,\n \"dependsOnOptionIndex\": 0,\n \"options\": [\n {\n \"label\": \"Yes\",\n \"order\": 0,\n \"isDefault\": true,\n \"actions\": [\n {\n \"type\": \"INCLUDE_DOCUMENT\",\n \"targetDocumentId\": \"cmg3k5r1c0003s7p4h2m8tb7k\",\n \"targetFieldId\": \"cmg3k7q9e0004s7p4b1z6lc3n\"\n }\n ]\n }\n ]\n }\n ],\n \"metadata\": \"<unknown>\",\n \"documentConfig\": [\n {\n \"documentId\": \"cmg3k5r1c0003s7p4h2m8tb7k\",\n \"variables\": [\n {\n \"ref\": \"v_3kq9x\",\n \"key\": \"start_date\",\n \"label\": \"Start date\",\n \"type\": \"TEXT\",\n \"source\": \"SENDER\",\n \"defaultValue\": \"2026-10-01\",\n \"isRequired\": true,\n \"dropdownOptions\": []\n }\n ],\n \"questions\": [\n {\n \"id\": \"cmg3k9y2h0006s7p4e4k7nq1t\",\n \"question\": \"Is a company car included?\",\n \"options\": [\n {\n \"id\": \"cmg3k9y2h0007s7p4g8d3rp6v\",\n \"label\": \"Yes\"\n }\n ]\n }\n ]\n }\n ],\n \"mergeFields\": [\n {\n \"key\": \"start_date\",\n \"label\": \"Start date\",\n \"order\": 0,\n \"description\": \"The employee's first day of work.\",\n \"source\": \"SENDER\",\n \"type\": \"DATE\",\n \"options\": [\n \"Full time\",\n \"Part time\"\n ],\n \"defaultValue\": \"2026-10-01\",\n \"isRequired\": true\n }\n ]\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
using RestSharp;
var options = new RestClientOptions("https://my.flowsign.app/api/v1/templates/{templateId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"name\": \"Employment agreement\",\n \"description\": \"Standard individual employment agreement for new hires.\",\n \"status\": \"ACTIVE\",\n \"tags\": [\n \"HR\",\n \"Onboarding\"\n ],\n \"reminderIntervalDays\": 3,\n \"expirationDays\": 30,\n \"expiryWarningDays\": 5,\n \"emailSubject\": \"Your employment agreement with Studio Phoenix Limited\",\n \"emailMessage\": \"Kia ora {{employee_name}}, please review and sign your agreement.\",\n \"signingMode\": \"SEQUENTIAL\",\n \"brandColor\": \"#1a2b3c\",\n \"roles\": [\n {\n \"name\": \"Employee\",\n \"order\": 0,\n \"id\": \"cmg3k2v8a0001s7p4d9x1qz2h\",\n \"actionType\": \"SIGNER\",\n \"deliveryDefault\": \"EMAIL\",\n \"hostRole\": \"SENDER\",\n \"hostUserIds\": [\n \"8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f\"\n ],\n \"hostGroupIds\": [\n \"cmg1hd3x10002v8p9f6r8bt4n\"\n ]\n }\n ],\n \"questions\": [\n {\n \"question\": \"Does the role include a company vehicle?\",\n \"order\": 0,\n \"type\": \"TOGGLE\",\n \"dependsOnQuestionIndex\": 0,\n \"dependsOnOptionIndex\": 0,\n \"options\": [\n {\n \"label\": \"Yes\",\n \"order\": 0,\n \"isDefault\": true,\n \"actions\": [\n {\n \"type\": \"INCLUDE_DOCUMENT\",\n \"targetDocumentId\": \"cmg3k5r1c0003s7p4h2m8tb7k\",\n \"targetFieldId\": \"cmg3k7q9e0004s7p4b1z6lc3n\"\n }\n ]\n }\n ]\n }\n ],\n \"metadata\": \"<unknown>\",\n \"documentConfig\": [\n {\n \"documentId\": \"cmg3k5r1c0003s7p4h2m8tb7k\",\n \"variables\": [\n {\n \"ref\": \"v_3kq9x\",\n \"key\": \"start_date\",\n \"label\": \"Start date\",\n \"type\": \"TEXT\",\n \"source\": \"SENDER\",\n \"defaultValue\": \"2026-10-01\",\n \"isRequired\": true,\n \"dropdownOptions\": []\n }\n ],\n \"questions\": [\n {\n \"id\": \"cmg3k9y2h0006s7p4e4k7nq1t\",\n \"question\": \"Is a company car included?\",\n \"options\": [\n {\n \"id\": \"cmg3k9y2h0007s7p4g8d3rp6v\",\n \"label\": \"Yes\"\n }\n ]\n }\n ]\n }\n ],\n \"mergeFields\": [\n {\n \"key\": \"start_date\",\n \"label\": \"Start date\",\n \"order\": 0,\n \"description\": \"The employee's first day of work.\",\n \"source\": \"SENDER\",\n \"type\": \"DATE\",\n \"options\": [\n \"Full time\",\n \"Part time\"\n ],\n \"defaultValue\": \"2026-10-01\",\n \"isRequired\": true\n }\n ]\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://my.flowsign.app/api/v1/templates/{templateId}' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"name": "Employment agreement",
"description": "Standard individual employment agreement for new hires.",
"status": "ACTIVE",
"tags": [
"HR",
"Onboarding"
],
"reminderIntervalDays": 3,
"expirationDays": 30,
"expiryWarningDays": 5,
"emailSubject": "Your employment agreement with Studio Phoenix Limited",
"emailMessage": "Kia ora {{employee_name}}, please review and sign your agreement.",
"signingMode": "SEQUENTIAL",
"brandColor": "#1a2b3c",
"roles": [
{
"name": "Employee",
"order": 0,
"id": "cmg3k2v8a0001s7p4d9x1qz2h",
"actionType": "SIGNER",
"deliveryDefault": "EMAIL",
"hostRole": "SENDER",
"hostUserIds": [
"8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f"
],
"hostGroupIds": [
"cmg1hd3x10002v8p9f6r8bt4n"
]
}
],
"questions": [
{
"question": "Does the role include a company vehicle?",
"order": 0,
"type": "TOGGLE",
"dependsOnQuestionIndex": 0,
"dependsOnOptionIndex": 0,
"options": [
{
"label": "Yes",
"order": 0,
"isDefault": true,
"actions": [
{
"type": "INCLUDE_DOCUMENT",
"targetDocumentId": "cmg3k5r1c0003s7p4h2m8tb7k",
"targetFieldId": "cmg3k7q9e0004s7p4b1z6lc3n"
}
]
}
]
}
],
"metadata": "<unknown>",
"documentConfig": [
{
"documentId": "cmg3k5r1c0003s7p4h2m8tb7k",
"variables": [
{
"ref": "v_3kq9x",
"key": "start_date",
"label": "Start date",
"type": "TEXT",
"source": "SENDER",
"defaultValue": "2026-10-01",
"isRequired": true,
"dropdownOptions": []
}
],
"questions": [
{
"id": "cmg3k9y2h0006s7p4e4k7nq1t",
"question": "Is a company car included?",
"options": [
{
"id": "cmg3k9y2h0007s7p4g8d3rp6v",
"label": "Yes"
}
]
}
]
}
],
"mergeFields": [
{
"key": "start_date",
"label": "Start date",
"order": 0,
"description": "The employee's first day of work.",
"source": "SENDER",
"type": "DATE",
"options": [
"Full time",
"Part time"
],
"defaultValue": "2026-10-01",
"isRequired": true
}
]
}'{
"data": {
"id": "kX9dQ2mB7pLw",
"warnings": [
"Question 2 depends on an answer that does not exist and was left unconditional"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}Templates
Update a template
Updates the fields given and leaves the rest as they are. Requires CREATE template access.
PATCH
https://my.flowsign.app
/
api
/
v1
/
templates
/
{templateId}
Update a template
curl --request PATCH \
--url https://my.flowsign.app/api/v1/templates/{templateId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"name": "Employment agreement",
"description": "Standard individual employment agreement for new hires.",
"status": "ACTIVE",
"tags": [
"HR",
"Onboarding"
],
"reminderIntervalDays": 3,
"expirationDays": 30,
"expiryWarningDays": 5,
"emailSubject": "Your employment agreement with Studio Phoenix Limited",
"emailMessage": "Kia ora {{employee_name}}, please review and sign your agreement.",
"signingMode": "SEQUENTIAL",
"brandColor": "#1a2b3c",
"roles": [
{
"name": "Employee",
"order": 0,
"id": "cmg3k2v8a0001s7p4d9x1qz2h",
"actionType": "SIGNER",
"deliveryDefault": "EMAIL",
"hostRole": "SENDER",
"hostUserIds": [
"8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f"
],
"hostGroupIds": [
"cmg1hd3x10002v8p9f6r8bt4n"
]
}
],
"questions": [
{
"question": "Does the role include a company vehicle?",
"order": 0,
"type": "TOGGLE",
"dependsOnQuestionIndex": 0,
"dependsOnOptionIndex": 0,
"options": [
{
"label": "Yes",
"order": 0,
"isDefault": true,
"actions": [
{
"type": "INCLUDE_DOCUMENT",
"targetDocumentId": "cmg3k5r1c0003s7p4h2m8tb7k",
"targetFieldId": "cmg3k7q9e0004s7p4b1z6lc3n"
}
]
}
]
}
],
"metadata": "<unknown>",
"documentConfig": [
{
"documentId": "cmg3k5r1c0003s7p4h2m8tb7k",
"variables": [
{
"ref": "v_3kq9x",
"key": "start_date",
"label": "Start date",
"type": "TEXT",
"source": "SENDER",
"defaultValue": "2026-10-01",
"isRequired": true,
"dropdownOptions": []
}
],
"questions": [
{
"id": "cmg3k9y2h0006s7p4e4k7nq1t",
"question": "Is a company car included?",
"options": [
{
"id": "cmg3k9y2h0007s7p4g8d3rp6v",
"label": "Yes"
}
]
}
]
}
],
"mergeFields": [
{
"key": "start_date",
"label": "Start date",
"order": 0,
"description": "The employee's first day of work.",
"source": "SENDER",
"type": "DATE",
"options": [
"Full time",
"Part time"
],
"defaultValue": "2026-10-01",
"isRequired": true
}
]
}
EOFconst options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Employment agreement',
description: 'Standard individual employment agreement for new hires.',
status: 'ACTIVE',
tags: ['HR', 'Onboarding'],
reminderIntervalDays: 3,
expirationDays: 30,
expiryWarningDays: 5,
emailSubject: 'Your employment agreement with Studio Phoenix Limited',
emailMessage: 'Kia ora {{employee_name}}, please review and sign your agreement.',
signingMode: 'SEQUENTIAL',
brandColor: '#1a2b3c',
roles: [
{
name: 'Employee',
order: 0,
id: 'cmg3k2v8a0001s7p4d9x1qz2h',
actionType: 'SIGNER',
deliveryDefault: 'EMAIL',
hostRole: 'SENDER',
hostUserIds: ['8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f'],
hostGroupIds: ['cmg1hd3x10002v8p9f6r8bt4n']
}
],
questions: [
{
question: 'Does the role include a company vehicle?',
order: 0,
type: 'TOGGLE',
dependsOnQuestionIndex: 0,
dependsOnOptionIndex: 0,
options: [
{
label: 'Yes',
order: 0,
isDefault: true,
actions: [
{
type: 'INCLUDE_DOCUMENT',
targetDocumentId: 'cmg3k5r1c0003s7p4h2m8tb7k',
targetFieldId: 'cmg3k7q9e0004s7p4b1z6lc3n'
}
]
}
]
}
],
metadata: '<unknown>',
documentConfig: [
{
documentId: 'cmg3k5r1c0003s7p4h2m8tb7k',
variables: [
{
ref: 'v_3kq9x',
key: 'start_date',
label: 'Start date',
type: 'TEXT',
source: 'SENDER',
defaultValue: '2026-10-01',
isRequired: true,
dropdownOptions: []
}
],
questions: [
{
id: 'cmg3k9y2h0006s7p4e4k7nq1t',
question: 'Is a company car included?',
options: [{id: 'cmg3k9y2h0007s7p4g8d3rp6v', label: 'Yes'}]
}
]
}
],
mergeFields: [
{
key: 'start_date',
label: 'Start date',
order: 0,
description: 'The employee\'s first day of work.',
source: 'SENDER',
type: 'DATE',
options: ['Full time', 'Part time'],
defaultValue: '2026-10-01',
isRequired: true
}
]
})
};
fetch('https://my.flowsign.app/api/v1/templates/{templateId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Employment agreement',
description: 'Standard individual employment agreement for new hires.',
status: 'ACTIVE',
tags: ['HR', 'Onboarding'],
reminderIntervalDays: 3,
expirationDays: 30,
expiryWarningDays: 5,
emailSubject: 'Your employment agreement with Studio Phoenix Limited',
emailMessage: 'Kia ora {{employee_name}}, please review and sign your agreement.',
signingMode: 'SEQUENTIAL',
brandColor: '#1a2b3c',
roles: [
{
name: 'Employee',
order: 0,
id: 'cmg3k2v8a0001s7p4d9x1qz2h',
actionType: 'SIGNER',
deliveryDefault: 'EMAIL',
hostRole: 'SENDER',
hostUserIds: ['8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f'],
hostGroupIds: ['cmg1hd3x10002v8p9f6r8bt4n']
}
],
questions: [
{
question: 'Does the role include a company vehicle?',
order: 0,
type: 'TOGGLE',
dependsOnQuestionIndex: 0,
dependsOnOptionIndex: 0,
options: [
{
label: 'Yes',
order: 0,
isDefault: true,
actions: [
{
type: 'INCLUDE_DOCUMENT',
targetDocumentId: 'cmg3k5r1c0003s7p4h2m8tb7k',
targetFieldId: 'cmg3k7q9e0004s7p4b1z6lc3n'
}
]
}
]
}
],
metadata: '<unknown>',
documentConfig: [
{
documentId: 'cmg3k5r1c0003s7p4h2m8tb7k',
variables: [
{
ref: 'v_3kq9x',
key: 'start_date',
label: 'Start date',
type: 'TEXT',
source: 'SENDER',
defaultValue: '2026-10-01',
isRequired: true,
dropdownOptions: []
}
],
questions: [
{
id: 'cmg3k9y2h0006s7p4e4k7nq1t',
question: 'Is a company car included?',
options: [{id: 'cmg3k9y2h0007s7p4g8d3rp6v', label: 'Yes'}]
}
]
}
],
mergeFields: [
{
key: 'start_date',
label: 'Start date',
order: 0,
description: 'The employee\'s first day of work.',
source: 'SENDER',
type: 'DATE',
options: ['Full time', 'Part time'],
defaultValue: '2026-10-01',
isRequired: true
}
]
})
};
fetch('https://my.flowsign.app/api/v1/templates/{templateId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://my.flowsign.app/api/v1/templates/{templateId}';
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Employment agreement',
description: 'Standard individual employment agreement for new hires.',
status: 'ACTIVE',
tags: ['HR', 'Onboarding'],
reminderIntervalDays: 3,
expirationDays: 30,
expiryWarningDays: 5,
emailSubject: 'Your employment agreement with Studio Phoenix Limited',
emailMessage: 'Kia ora {{employee_name}}, please review and sign your agreement.',
signingMode: 'SEQUENTIAL',
brandColor: '#1a2b3c',
roles: [
{
name: 'Employee',
order: 0,
id: 'cmg3k2v8a0001s7p4d9x1qz2h',
actionType: 'SIGNER',
deliveryDefault: 'EMAIL',
hostRole: 'SENDER',
hostUserIds: ['8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f'],
hostGroupIds: ['cmg1hd3x10002v8p9f6r8bt4n']
}
],
questions: [
{
question: 'Does the role include a company vehicle?',
order: 0,
type: 'TOGGLE',
dependsOnQuestionIndex: 0,
dependsOnOptionIndex: 0,
options: [
{
label: 'Yes',
order: 0,
isDefault: true,
actions: [
{
type: 'INCLUDE_DOCUMENT',
targetDocumentId: 'cmg3k5r1c0003s7p4h2m8tb7k',
targetFieldId: 'cmg3k7q9e0004s7p4b1z6lc3n'
}
]
}
]
}
],
metadata: '<unknown>',
documentConfig: [
{
documentId: 'cmg3k5r1c0003s7p4h2m8tb7k',
variables: [
{
ref: 'v_3kq9x',
key: 'start_date',
label: 'Start date',
type: 'TEXT',
source: 'SENDER',
defaultValue: '2026-10-01',
isRequired: true,
dropdownOptions: []
}
],
questions: [
{
id: 'cmg3k9y2h0006s7p4e4k7nq1t',
question: 'Is a company car included?',
options: [{id: 'cmg3k9y2h0007s7p4g8d3rp6v', label: 'Yes'}]
}
]
}
],
mergeFields: [
{
key: 'start_date',
label: 'Start date',
order: 0,
description: 'The employee\'s first day of work.',
source: 'SENDER',
type: 'DATE',
options: ['Full time', 'Part time'],
defaultValue: '2026-10-01',
isRequired: true
}
]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://my.flowsign.app/api/v1/templates/{templateId}"
payload = {
"name": "Employment agreement",
"description": "Standard individual employment agreement for new hires.",
"status": "ACTIVE",
"tags": ["HR", "Onboarding"],
"reminderIntervalDays": 3,
"expirationDays": 30,
"expiryWarningDays": 5,
"emailSubject": "Your employment agreement with Studio Phoenix Limited",
"emailMessage": "Kia ora {{employee_name}}, please review and sign your agreement.",
"signingMode": "SEQUENTIAL",
"brandColor": "#1a2b3c",
"roles": [
{
"name": "Employee",
"order": 0,
"id": "cmg3k2v8a0001s7p4d9x1qz2h",
"actionType": "SIGNER",
"deliveryDefault": "EMAIL",
"hostRole": "SENDER",
"hostUserIds": ["8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f"],
"hostGroupIds": ["cmg1hd3x10002v8p9f6r8bt4n"]
}
],
"questions": [
{
"question": "Does the role include a company vehicle?",
"order": 0,
"type": "TOGGLE",
"dependsOnQuestionIndex": 0,
"dependsOnOptionIndex": 0,
"options": [
{
"label": "Yes",
"order": 0,
"isDefault": True,
"actions": [
{
"type": "INCLUDE_DOCUMENT",
"targetDocumentId": "cmg3k5r1c0003s7p4h2m8tb7k",
"targetFieldId": "cmg3k7q9e0004s7p4b1z6lc3n"
}
]
}
]
}
],
"metadata": "<unknown>",
"documentConfig": [
{
"documentId": "cmg3k5r1c0003s7p4h2m8tb7k",
"variables": [
{
"ref": "v_3kq9x",
"key": "start_date",
"label": "Start date",
"type": "TEXT",
"source": "SENDER",
"defaultValue": "2026-10-01",
"isRequired": True,
"dropdownOptions": []
}
],
"questions": [
{
"id": "cmg3k9y2h0006s7p4e4k7nq1t",
"question": "Is a company car included?",
"options": [
{
"id": "cmg3k9y2h0007s7p4g8d3rp6v",
"label": "Yes"
}
]
}
]
}
],
"mergeFields": [
{
"key": "start_date",
"label": "Start date",
"order": 0,
"description": "The employee's first day of work.",
"source": "SENDER",
"type": "DATE",
"options": ["Full time", "Part time"],
"defaultValue": "2026-10-01",
"isRequired": True
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://my.flowsign.app/api/v1/templates/{templateId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"name\": \"Employment agreement\",\n \"description\": \"Standard individual employment agreement for new hires.\",\n \"status\": \"ACTIVE\",\n \"tags\": [\n \"HR\",\n \"Onboarding\"\n ],\n \"reminderIntervalDays\": 3,\n \"expirationDays\": 30,\n \"expiryWarningDays\": 5,\n \"emailSubject\": \"Your employment agreement with Studio Phoenix Limited\",\n \"emailMessage\": \"Kia ora {{employee_name}}, please review and sign your agreement.\",\n \"signingMode\": \"SEQUENTIAL\",\n \"brandColor\": \"#1a2b3c\",\n \"roles\": [\n {\n \"name\": \"Employee\",\n \"order\": 0,\n \"id\": \"cmg3k2v8a0001s7p4d9x1qz2h\",\n \"actionType\": \"SIGNER\",\n \"deliveryDefault\": \"EMAIL\",\n \"hostRole\": \"SENDER\",\n \"hostUserIds\": [\n \"8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f\"\n ],\n \"hostGroupIds\": [\n \"cmg1hd3x10002v8p9f6r8bt4n\"\n ]\n }\n ],\n \"questions\": [\n {\n \"question\": \"Does the role include a company vehicle?\",\n \"order\": 0,\n \"type\": \"TOGGLE\",\n \"dependsOnQuestionIndex\": 0,\n \"dependsOnOptionIndex\": 0,\n \"options\": [\n {\n \"label\": \"Yes\",\n \"order\": 0,\n \"isDefault\": true,\n \"actions\": [\n {\n \"type\": \"INCLUDE_DOCUMENT\",\n \"targetDocumentId\": \"cmg3k5r1c0003s7p4h2m8tb7k\",\n \"targetFieldId\": \"cmg3k7q9e0004s7p4b1z6lc3n\"\n }\n ]\n }\n ]\n }\n ],\n \"metadata\": \"<unknown>\",\n \"documentConfig\": [\n {\n \"documentId\": \"cmg3k5r1c0003s7p4h2m8tb7k\",\n \"variables\": [\n {\n \"ref\": \"v_3kq9x\",\n \"key\": \"start_date\",\n \"label\": \"Start date\",\n \"type\": \"TEXT\",\n \"source\": \"SENDER\",\n \"defaultValue\": \"2026-10-01\",\n \"isRequired\": true,\n \"dropdownOptions\": []\n }\n ],\n \"questions\": [\n {\n \"id\": \"cmg3k9y2h0006s7p4e4k7nq1t\",\n \"question\": \"Is a company car included?\",\n \"options\": [\n {\n \"id\": \"cmg3k9y2h0007s7p4g8d3rp6v\",\n \"label\": \"Yes\"\n }\n ]\n }\n ]\n }\n ],\n \"mergeFields\": [\n {\n \"key\": \"start_date\",\n \"label\": \"Start date\",\n \"order\": 0,\n \"description\": \"The employee's first day of work.\",\n \"source\": \"SENDER\",\n \"type\": \"DATE\",\n \"options\": [\n \"Full time\",\n \"Part time\"\n ],\n \"defaultValue\": \"2026-10-01\",\n \"isRequired\": true\n }\n ]\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
using RestSharp;
var options = new RestClientOptions("https://my.flowsign.app/api/v1/templates/{templateId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"name\": \"Employment agreement\",\n \"description\": \"Standard individual employment agreement for new hires.\",\n \"status\": \"ACTIVE\",\n \"tags\": [\n \"HR\",\n \"Onboarding\"\n ],\n \"reminderIntervalDays\": 3,\n \"expirationDays\": 30,\n \"expiryWarningDays\": 5,\n \"emailSubject\": \"Your employment agreement with Studio Phoenix Limited\",\n \"emailMessage\": \"Kia ora {{employee_name}}, please review and sign your agreement.\",\n \"signingMode\": \"SEQUENTIAL\",\n \"brandColor\": \"#1a2b3c\",\n \"roles\": [\n {\n \"name\": \"Employee\",\n \"order\": 0,\n \"id\": \"cmg3k2v8a0001s7p4d9x1qz2h\",\n \"actionType\": \"SIGNER\",\n \"deliveryDefault\": \"EMAIL\",\n \"hostRole\": \"SENDER\",\n \"hostUserIds\": [\n \"8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f\"\n ],\n \"hostGroupIds\": [\n \"cmg1hd3x10002v8p9f6r8bt4n\"\n ]\n }\n ],\n \"questions\": [\n {\n \"question\": \"Does the role include a company vehicle?\",\n \"order\": 0,\n \"type\": \"TOGGLE\",\n \"dependsOnQuestionIndex\": 0,\n \"dependsOnOptionIndex\": 0,\n \"options\": [\n {\n \"label\": \"Yes\",\n \"order\": 0,\n \"isDefault\": true,\n \"actions\": [\n {\n \"type\": \"INCLUDE_DOCUMENT\",\n \"targetDocumentId\": \"cmg3k5r1c0003s7p4h2m8tb7k\",\n \"targetFieldId\": \"cmg3k7q9e0004s7p4b1z6lc3n\"\n }\n ]\n }\n ]\n }\n ],\n \"metadata\": \"<unknown>\",\n \"documentConfig\": [\n {\n \"documentId\": \"cmg3k5r1c0003s7p4h2m8tb7k\",\n \"variables\": [\n {\n \"ref\": \"v_3kq9x\",\n \"key\": \"start_date\",\n \"label\": \"Start date\",\n \"type\": \"TEXT\",\n \"source\": \"SENDER\",\n \"defaultValue\": \"2026-10-01\",\n \"isRequired\": true,\n \"dropdownOptions\": []\n }\n ],\n \"questions\": [\n {\n \"id\": \"cmg3k9y2h0006s7p4e4k7nq1t\",\n \"question\": \"Is a company car included?\",\n \"options\": [\n {\n \"id\": \"cmg3k9y2h0007s7p4g8d3rp6v\",\n \"label\": \"Yes\"\n }\n ]\n }\n ]\n }\n ],\n \"mergeFields\": [\n {\n \"key\": \"start_date\",\n \"label\": \"Start date\",\n \"order\": 0,\n \"description\": \"The employee's first day of work.\",\n \"source\": \"SENDER\",\n \"type\": \"DATE\",\n \"options\": [\n \"Full time\",\n \"Part time\"\n ],\n \"defaultValue\": \"2026-10-01\",\n \"isRequired\": true\n }\n ]\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://my.flowsign.app/api/v1/templates/{templateId}' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"name": "Employment agreement",
"description": "Standard individual employment agreement for new hires.",
"status": "ACTIVE",
"tags": [
"HR",
"Onboarding"
],
"reminderIntervalDays": 3,
"expirationDays": 30,
"expiryWarningDays": 5,
"emailSubject": "Your employment agreement with Studio Phoenix Limited",
"emailMessage": "Kia ora {{employee_name}}, please review and sign your agreement.",
"signingMode": "SEQUENTIAL",
"brandColor": "#1a2b3c",
"roles": [
{
"name": "Employee",
"order": 0,
"id": "cmg3k2v8a0001s7p4d9x1qz2h",
"actionType": "SIGNER",
"deliveryDefault": "EMAIL",
"hostRole": "SENDER",
"hostUserIds": [
"8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f"
],
"hostGroupIds": [
"cmg1hd3x10002v8p9f6r8bt4n"
]
}
],
"questions": [
{
"question": "Does the role include a company vehicle?",
"order": 0,
"type": "TOGGLE",
"dependsOnQuestionIndex": 0,
"dependsOnOptionIndex": 0,
"options": [
{
"label": "Yes",
"order": 0,
"isDefault": true,
"actions": [
{
"type": "INCLUDE_DOCUMENT",
"targetDocumentId": "cmg3k5r1c0003s7p4h2m8tb7k",
"targetFieldId": "cmg3k7q9e0004s7p4b1z6lc3n"
}
]
}
]
}
],
"metadata": "<unknown>",
"documentConfig": [
{
"documentId": "cmg3k5r1c0003s7p4h2m8tb7k",
"variables": [
{
"ref": "v_3kq9x",
"key": "start_date",
"label": "Start date",
"type": "TEXT",
"source": "SENDER",
"defaultValue": "2026-10-01",
"isRequired": true,
"dropdownOptions": []
}
],
"questions": [
{
"id": "cmg3k9y2h0006s7p4e4k7nq1t",
"question": "Is a company car included?",
"options": [
{
"id": "cmg3k9y2h0007s7p4g8d3rp6v",
"label": "Yes"
}
]
}
]
}
],
"mergeFields": [
{
"key": "start_date",
"label": "Start date",
"order": 0,
"description": "The employee's first day of work.",
"source": "SENDER",
"type": "DATE",
"options": [
"Full time",
"Part time"
],
"defaultValue": "2026-10-01",
"isRequired": true
}
]
}'{
"data": {
"id": "kX9dQ2mB7pLw",
"warnings": [
"Question 2 depends on an answer that does not exist and was left unconditional"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The workspace the key was issued for, as returned by GET /api/v1/workspaces. Optional: omitting it acts in the key's workspace, and any other id is rejected with 401.
Path Parameters
Body
application/json
The template's name.
Minimum string length:
1Example:
"Employment agreement"
Free-text description of what the template is for.
Example:
"Standard individual employment agreement for new hires."
New lifecycle state: DRAFT, ACTIVE or ARCHIVED. Moving to ACTIVE for the first time stamps the publish time; moving to ARCHIVED stamps the archive time and moving out of it clears it. An update that leaves a WORKFLOW template ACTIVE is refused with 400 while its questions break a workflow rule.
Available options:
DRAFT, ACTIVE, ARCHIVED Example:
"ACTIVE"
Replaces the template's tags with this set. A tag that does not exist yet is created.
Example:
["HR", "Onboarding"]
Days between automatic reminders to each recipient who hasn't finished, counted from their invitation. Null or absent sends none.
Required range:
x >= 1Example:
3
Days the package stays open for signing, counted from when it is sent. Null or absent means it never expires.
Required range:
x >= 1Example:
30
Days before expiry at which recipients who haven't finished are warned. MUST be fewer than expirationDays.
Required range:
x >= 1Example:
5
Subject of the invitation email. {{key}} placeholders are filled from the package's merge field values.
Example:
"Your employment agreement with Studio Phoenix Limited"
Body of the invitation email. {{key}} placeholders are filled from the package's merge field values.
Example:
"Kia ora {{employee_name}}, please review and sign your agreement."
How recipients are walked through signing. PARALLEL invites every recipient at once; SEQUENTIAL invites one at a time in order; WORKFLOW follows the template's workflow, asking recipients its questions as they open the package.
Available options:
PARALLEL, SEQUENTIAL, WORKFLOW Example:
"SEQUENTIAL"
Accent colour for the signing experience and emails, as a six-digit hex code. Needs a plan with custom branding, otherwise 402. Null clears it.
Pattern:
^#[0-9a-fA-F]{6}$Example:
"#1a2b3c"
Replaces the roles. A role carrying its id keeps that id and the fields placed for it; a role left out is removed with its fields, and removing one the workflow uses is a 409. The recipient cap still applies. Omit to keep the current roles.
Show child attributes
Show child attributes
Replaces the workflow's questions wholesale. Needs signingMode WORKFLOW, set here or already on the template, or it is a 422. Questions reference each other by position in this array; an action's targetDocumentId is a document id from GET /api/v1/templates/:templateId. Omit to keep the current questions.
Show child attributes
Show child attributes
Not accepted. A template's default custom field values are set in the app; sending this is refused with 400 and nothing is saved.
Changes to DYNAMIC documents' variables and question wording. Variables themselves come from the content and cannot be added here. A change that leaves a document's config invalid (a duplicate key, a MAPPED variable without a binding) is a 422.
Show child attributes
Show child attributes
Replaces every merge field. Blank at launch means the field's default. Omit to keep the current merge fields.
Show child attributes
Show child attributes
Response
Success
Show child attributes
Show child attributes
Was this page helpful?