curl --request POST \
--url https://my.flowsign.app/api/v1/templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"name": "Employment agreement",
"roles": [
{
"name": "Employee",
"order": 0,
"id": "cmg3k2v8a0001s7p4d9x1qz2h",
"actionType": "SIGNER",
"deliveryDefault": "EMAIL",
"hostRole": "SENDER",
"hostUserIds": [
"8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f"
],
"hostGroupIds": [
"cmg1hd3x10002v8p9f6r8bt4n"
]
}
],
"description": "Standard individual employment agreement for new hires.",
"status": "DRAFT",
"tags": [
"HR",
"Onboarding"
],
"reminderIntervalDays": 3,
"expirationDays": 30,
"expiryWarningDays": 5,
"emailSubject": "Your employment agreement with Ashcombe Advisory Limited",
"emailMessage": "Kia ora {{employee_name}}, please review and sign your agreement.",
"signingMode": "SEQUENTIAL",
"brandColor": "#1a2b3c",
"metadata": "<unknown>",
"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"
}
]
}
]
}
],
"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: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Employment agreement',
roles: [
{
name: 'Employee',
order: 0,
id: 'cmg3k2v8a0001s7p4d9x1qz2h',
actionType: 'SIGNER',
deliveryDefault: 'EMAIL',
hostRole: 'SENDER',
hostUserIds: ['8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f'],
hostGroupIds: ['cmg1hd3x10002v8p9f6r8bt4n']
}
],
description: 'Standard individual employment agreement for new hires.',
status: 'DRAFT',
tags: ['HR', 'Onboarding'],
reminderIntervalDays: 3,
expirationDays: 30,
expiryWarningDays: 5,
emailSubject: 'Your employment agreement with Ashcombe Advisory Limited',
emailMessage: 'Kia ora {{employee_name}}, please review and sign your agreement.',
signingMode: 'SEQUENTIAL',
brandColor: '#1a2b3c',
metadata: '<unknown>',
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'
}
]
}
]
}
],
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', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Employment agreement',
roles: [
{
name: 'Employee',
order: 0,
id: 'cmg3k2v8a0001s7p4d9x1qz2h',
actionType: 'SIGNER',
deliveryDefault: 'EMAIL',
hostRole: 'SENDER',
hostUserIds: ['8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f'],
hostGroupIds: ['cmg1hd3x10002v8p9f6r8bt4n']
}
],
description: 'Standard individual employment agreement for new hires.',
status: 'DRAFT',
tags: ['HR', 'Onboarding'],
reminderIntervalDays: 3,
expirationDays: 30,
expiryWarningDays: 5,
emailSubject: 'Your employment agreement with Ashcombe Advisory Limited',
emailMessage: 'Kia ora {{employee_name}}, please review and sign your agreement.',
signingMode: 'SEQUENTIAL',
brandColor: '#1a2b3c',
metadata: '<unknown>',
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'
}
]
}
]
}
],
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', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://my.flowsign.app/api/v1/templates';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Employment agreement',
roles: [
{
name: 'Employee',
order: 0,
id: 'cmg3k2v8a0001s7p4d9x1qz2h',
actionType: 'SIGNER',
deliveryDefault: 'EMAIL',
hostRole: 'SENDER',
hostUserIds: ['8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f'],
hostGroupIds: ['cmg1hd3x10002v8p9f6r8bt4n']
}
],
description: 'Standard individual employment agreement for new hires.',
status: 'DRAFT',
tags: ['HR', 'Onboarding'],
reminderIntervalDays: 3,
expirationDays: 30,
expiryWarningDays: 5,
emailSubject: 'Your employment agreement with Ashcombe Advisory Limited',
emailMessage: 'Kia ora {{employee_name}}, please review and sign your agreement.',
signingMode: 'SEQUENTIAL',
brandColor: '#1a2b3c',
metadata: '<unknown>',
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'
}
]
}
]
}
],
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"
payload = {
"name": "Employment agreement",
"roles": [
{
"name": "Employee",
"order": 0,
"id": "cmg3k2v8a0001s7p4d9x1qz2h",
"actionType": "SIGNER",
"deliveryDefault": "EMAIL",
"hostRole": "SENDER",
"hostUserIds": ["8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f"],
"hostGroupIds": ["cmg1hd3x10002v8p9f6r8bt4n"]
}
],
"description": "Standard individual employment agreement for new hires.",
"status": "DRAFT",
"tags": ["HR", "Onboarding"],
"reminderIntervalDays": 3,
"expirationDays": 30,
"expiryWarningDays": 5,
"emailSubject": "Your employment agreement with Ashcombe Advisory Limited",
"emailMessage": "Kia ora {{employee_name}}, please review and sign your agreement.",
"signingMode": "SEQUENTIAL",
"brandColor": "#1a2b3c",
"metadata": "<unknown>",
"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"
}
]
}
]
}
],
"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.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://my.flowsign.app/api/v1/templates");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"name\": \"Employment agreement\",\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 \"description\": \"Standard individual employment agreement for new hires.\",\n \"status\": \"DRAFT\",\n \"tags\": [\n \"HR\",\n \"Onboarding\"\n ],\n \"reminderIntervalDays\": 3,\n \"expirationDays\": 30,\n \"expiryWarningDays\": 5,\n \"emailSubject\": \"Your employment agreement with Ashcombe Advisory Limited\",\n \"emailMessage\": \"Kia ora {{employee_name}}, please review and sign your agreement.\",\n \"signingMode\": \"SEQUENTIAL\",\n \"brandColor\": \"#1a2b3c\",\n \"metadata\": \"<unknown>\",\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 \"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.PostAsync(request);
Console.WriteLine("{0}", response.Content);
using RestSharp;
var options = new RestClientOptions("https://my.flowsign.app/api/v1/templates");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"name\": \"Employment agreement\",\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 \"description\": \"Standard individual employment agreement for new hires.\",\n \"status\": \"DRAFT\",\n \"tags\": [\n \"HR\",\n \"Onboarding\"\n ],\n \"reminderIntervalDays\": 3,\n \"expirationDays\": 30,\n \"expiryWarningDays\": 5,\n \"emailSubject\": \"Your employment agreement with Ashcombe Advisory Limited\",\n \"emailMessage\": \"Kia ora {{employee_name}}, please review and sign your agreement.\",\n \"signingMode\": \"SEQUENTIAL\",\n \"brandColor\": \"#1a2b3c\",\n \"metadata\": \"<unknown>\",\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 \"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.PostAsync(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' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"name": "Employment agreement",
"roles": [
{
"name": "Employee",
"order": 0,
"id": "cmg3k2v8a0001s7p4d9x1qz2h",
"actionType": "SIGNER",
"deliveryDefault": "EMAIL",
"hostRole": "SENDER",
"hostUserIds": [
"8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f"
],
"hostGroupIds": [
"cmg1hd3x10002v8p9f6r8bt4n"
]
}
],
"description": "Standard individual employment agreement for new hires.",
"status": "DRAFT",
"tags": [
"HR",
"Onboarding"
],
"reminderIntervalDays": 3,
"expirationDays": 30,
"expiryWarningDays": 5,
"emailSubject": "Your employment agreement with Ashcombe Advisory Limited",
"emailMessage": "Kia ora {{employee_name}}, please review and sign your agreement.",
"signingMode": "SEQUENTIAL",
"brandColor": "#1a2b3c",
"metadata": "<unknown>",
"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"
}
]
}
]
}
],
"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"
]
}
}Create a template
Creates a reusable template with roles, optional questions and merge fields. Requires CREATE template access, and answers 402 when the plan’s template cap is reached.
curl --request POST \
--url https://my.flowsign.app/api/v1/templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"name": "Employment agreement",
"roles": [
{
"name": "Employee",
"order": 0,
"id": "cmg3k2v8a0001s7p4d9x1qz2h",
"actionType": "SIGNER",
"deliveryDefault": "EMAIL",
"hostRole": "SENDER",
"hostUserIds": [
"8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f"
],
"hostGroupIds": [
"cmg1hd3x10002v8p9f6r8bt4n"
]
}
],
"description": "Standard individual employment agreement for new hires.",
"status": "DRAFT",
"tags": [
"HR",
"Onboarding"
],
"reminderIntervalDays": 3,
"expirationDays": 30,
"expiryWarningDays": 5,
"emailSubject": "Your employment agreement with Ashcombe Advisory Limited",
"emailMessage": "Kia ora {{employee_name}}, please review and sign your agreement.",
"signingMode": "SEQUENTIAL",
"brandColor": "#1a2b3c",
"metadata": "<unknown>",
"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"
}
]
}
]
}
],
"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: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Employment agreement',
roles: [
{
name: 'Employee',
order: 0,
id: 'cmg3k2v8a0001s7p4d9x1qz2h',
actionType: 'SIGNER',
deliveryDefault: 'EMAIL',
hostRole: 'SENDER',
hostUserIds: ['8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f'],
hostGroupIds: ['cmg1hd3x10002v8p9f6r8bt4n']
}
],
description: 'Standard individual employment agreement for new hires.',
status: 'DRAFT',
tags: ['HR', 'Onboarding'],
reminderIntervalDays: 3,
expirationDays: 30,
expiryWarningDays: 5,
emailSubject: 'Your employment agreement with Ashcombe Advisory Limited',
emailMessage: 'Kia ora {{employee_name}}, please review and sign your agreement.',
signingMode: 'SEQUENTIAL',
brandColor: '#1a2b3c',
metadata: '<unknown>',
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'
}
]
}
]
}
],
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', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Employment agreement',
roles: [
{
name: 'Employee',
order: 0,
id: 'cmg3k2v8a0001s7p4d9x1qz2h',
actionType: 'SIGNER',
deliveryDefault: 'EMAIL',
hostRole: 'SENDER',
hostUserIds: ['8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f'],
hostGroupIds: ['cmg1hd3x10002v8p9f6r8bt4n']
}
],
description: 'Standard individual employment agreement for new hires.',
status: 'DRAFT',
tags: ['HR', 'Onboarding'],
reminderIntervalDays: 3,
expirationDays: 30,
expiryWarningDays: 5,
emailSubject: 'Your employment agreement with Ashcombe Advisory Limited',
emailMessage: 'Kia ora {{employee_name}}, please review and sign your agreement.',
signingMode: 'SEQUENTIAL',
brandColor: '#1a2b3c',
metadata: '<unknown>',
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'
}
]
}
]
}
],
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', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://my.flowsign.app/api/v1/templates';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Employment agreement',
roles: [
{
name: 'Employee',
order: 0,
id: 'cmg3k2v8a0001s7p4d9x1qz2h',
actionType: 'SIGNER',
deliveryDefault: 'EMAIL',
hostRole: 'SENDER',
hostUserIds: ['8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f'],
hostGroupIds: ['cmg1hd3x10002v8p9f6r8bt4n']
}
],
description: 'Standard individual employment agreement for new hires.',
status: 'DRAFT',
tags: ['HR', 'Onboarding'],
reminderIntervalDays: 3,
expirationDays: 30,
expiryWarningDays: 5,
emailSubject: 'Your employment agreement with Ashcombe Advisory Limited',
emailMessage: 'Kia ora {{employee_name}}, please review and sign your agreement.',
signingMode: 'SEQUENTIAL',
brandColor: '#1a2b3c',
metadata: '<unknown>',
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'
}
]
}
]
}
],
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"
payload = {
"name": "Employment agreement",
"roles": [
{
"name": "Employee",
"order": 0,
"id": "cmg3k2v8a0001s7p4d9x1qz2h",
"actionType": "SIGNER",
"deliveryDefault": "EMAIL",
"hostRole": "SENDER",
"hostUserIds": ["8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f"],
"hostGroupIds": ["cmg1hd3x10002v8p9f6r8bt4n"]
}
],
"description": "Standard individual employment agreement for new hires.",
"status": "DRAFT",
"tags": ["HR", "Onboarding"],
"reminderIntervalDays": 3,
"expirationDays": 30,
"expiryWarningDays": 5,
"emailSubject": "Your employment agreement with Ashcombe Advisory Limited",
"emailMessage": "Kia ora {{employee_name}}, please review and sign your agreement.",
"signingMode": "SEQUENTIAL",
"brandColor": "#1a2b3c",
"metadata": "<unknown>",
"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"
}
]
}
]
}
],
"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.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://my.flowsign.app/api/v1/templates");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"name\": \"Employment agreement\",\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 \"description\": \"Standard individual employment agreement for new hires.\",\n \"status\": \"DRAFT\",\n \"tags\": [\n \"HR\",\n \"Onboarding\"\n ],\n \"reminderIntervalDays\": 3,\n \"expirationDays\": 30,\n \"expiryWarningDays\": 5,\n \"emailSubject\": \"Your employment agreement with Ashcombe Advisory Limited\",\n \"emailMessage\": \"Kia ora {{employee_name}}, please review and sign your agreement.\",\n \"signingMode\": \"SEQUENTIAL\",\n \"brandColor\": \"#1a2b3c\",\n \"metadata\": \"<unknown>\",\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 \"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.PostAsync(request);
Console.WriteLine("{0}", response.Content);
using RestSharp;
var options = new RestClientOptions("https://my.flowsign.app/api/v1/templates");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"name\": \"Employment agreement\",\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 \"description\": \"Standard individual employment agreement for new hires.\",\n \"status\": \"DRAFT\",\n \"tags\": [\n \"HR\",\n \"Onboarding\"\n ],\n \"reminderIntervalDays\": 3,\n \"expirationDays\": 30,\n \"expiryWarningDays\": 5,\n \"emailSubject\": \"Your employment agreement with Ashcombe Advisory Limited\",\n \"emailMessage\": \"Kia ora {{employee_name}}, please review and sign your agreement.\",\n \"signingMode\": \"SEQUENTIAL\",\n \"brandColor\": \"#1a2b3c\",\n \"metadata\": \"<unknown>\",\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 \"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.PostAsync(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' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"name": "Employment agreement",
"roles": [
{
"name": "Employee",
"order": 0,
"id": "cmg3k2v8a0001s7p4d9x1qz2h",
"actionType": "SIGNER",
"deliveryDefault": "EMAIL",
"hostRole": "SENDER",
"hostUserIds": [
"8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f"
],
"hostGroupIds": [
"cmg1hd3x10002v8p9f6r8bt4n"
]
}
],
"description": "Standard individual employment agreement for new hires.",
"status": "DRAFT",
"tags": [
"HR",
"Onboarding"
],
"reminderIntervalDays": 3,
"expirationDays": 30,
"expiryWarningDays": 5,
"emailSubject": "Your employment agreement with Ashcombe Advisory Limited",
"emailMessage": "Kia ora {{employee_name}}, please review and sign your agreement.",
"signingMode": "SEQUENTIAL",
"brandColor": "#1a2b3c",
"metadata": "<unknown>",
"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"
}
]
}
]
}
],
"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"
]
}
}Authorizations
Headers
Required on a key that acts for members, refused on any other key. Names the member the call runs as, as key=value: email=jane@acme.com, employee_id=E-1001, scim_external_id=… or a custom identifier. Keys are lowercase and matched case-insensitively. The call fails with 403 when no active member of the workspace matches.
Body
Initial lifecycle state. Defaults to DRAFT. ACTIVE also stamps the publish time; ARCHIVED stamps the archive time. ACTIVE is refused with 400 when signingMode is WORKFLOW and the questions break a workflow rule; save as DRAFT to keep them and read the problems from warnings.
DRAFT, ACTIVE, ARCHIVED "DRAFT"
How recipients are walked through signing. PARALLEL (the default) invites every role at once; SEQUENTIAL invites one role at a time in order; WORKFLOW follows the template's workflow, asking recipients its questions as they open the package.
PARALLEL, SEQUENTIAL, WORKFLOW "SEQUENTIAL"
Was this page helpful?

