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 '
{
"name": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"reminderDaysAfterSend": 1,
"expirationDays": 1,
"expiryWarningDays": 1,
"emailSubject": "<string>",
"emailMessage": "<string>",
"lockDocuments": true,
"lockRoles": true,
"lockFields": true,
"brandColor": "<string>",
"roles": [
{
"name": "<string>",
"order": 1
}
],
"questions": [
{
"question": "<string>",
"order": 1,
"dependsOnQuestionIndex": 1,
"dependsOnOptionIndex": 1,
"options": [
{
"label": "<string>",
"order": 1,
"isDefault": true,
"actions": [
{
"targetDocumentId": "<string>",
"targetFieldId": "<string>"
}
],
"regionEffects": [
{
"regionId": "<string>",
"variantId": "<string>"
}
],
"variableBindings": [
{
"mergeFieldKey": "<string>",
"value": "<string>"
}
]
}
]
}
],
"mergeFields": [
{
"key": "<string>",
"label": "<string>",
"order": 1,
"description": "<string>",
"source": "<string>",
"defaultValue": "<string>",
"isRequired": true
}
]
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
tags: ['<string>'],
reminderDaysAfterSend: 1,
expirationDays: 1,
expiryWarningDays: 1,
emailSubject: '<string>',
emailMessage: '<string>',
lockDocuments: true,
lockRoles: true,
lockFields: true,
brandColor: '<string>',
roles: [{name: '<string>', order: 1}],
questions: [
{
question: '<string>',
order: 1,
dependsOnQuestionIndex: 1,
dependsOnOptionIndex: 1,
options: [
{
label: '<string>',
order: 1,
isDefault: true,
actions: [{targetDocumentId: '<string>', targetFieldId: '<string>'}],
regionEffects: [{regionId: '<string>', variantId: '<string>'}],
variableBindings: [{mergeFieldKey: '<string>', value: '<string>'}]
}
]
}
],
mergeFields: [
{
key: '<string>',
label: '<string>',
order: 1,
description: '<string>',
source: '<string>',
defaultValue: '<string>',
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));import requests
url = "https://my.flowsign.app/api/v1/templates/{templateId}"
payload = {
"name": "<string>",
"description": "<string>",
"tags": ["<string>"],
"reminderDaysAfterSend": 1,
"expirationDays": 1,
"expiryWarningDays": 1,
"emailSubject": "<string>",
"emailMessage": "<string>",
"lockDocuments": True,
"lockRoles": True,
"lockFields": True,
"brandColor": "<string>",
"roles": [
{
"name": "<string>",
"order": 1
}
],
"questions": [
{
"question": "<string>",
"order": 1,
"dependsOnQuestionIndex": 1,
"dependsOnOptionIndex": 1,
"options": [
{
"label": "<string>",
"order": 1,
"isDefault": True,
"actions": [
{
"targetDocumentId": "<string>",
"targetFieldId": "<string>"
}
],
"regionEffects": [
{
"regionId": "<string>",
"variantId": "<string>"
}
],
"variableBindings": [
{
"mergeFieldKey": "<string>",
"value": "<string>"
}
]
}
]
}
],
"mergeFields": [
{
"key": "<string>",
"label": "<string>",
"order": 1,
"description": "<string>",
"source": "<string>",
"defaultValue": "<string>",
"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\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"reminderDaysAfterSend\": 1,\n \"expirationDays\": 1,\n \"expiryWarningDays\": 1,\n \"emailSubject\": \"<string>\",\n \"emailMessage\": \"<string>\",\n \"lockDocuments\": true,\n \"lockRoles\": true,\n \"lockFields\": true,\n \"brandColor\": \"<string>\",\n \"roles\": [\n {\n \"name\": \"<string>\",\n \"order\": 1\n }\n ],\n \"questions\": [\n {\n \"question\": \"<string>\",\n \"order\": 1,\n \"dependsOnQuestionIndex\": 1,\n \"dependsOnOptionIndex\": 1,\n \"options\": [\n {\n \"label\": \"<string>\",\n \"order\": 1,\n \"isDefault\": true,\n \"actions\": [\n {\n \"targetDocumentId\": \"<string>\",\n \"targetFieldId\": \"<string>\"\n }\n ],\n \"regionEffects\": [\n {\n \"regionId\": \"<string>\",\n \"variantId\": \"<string>\"\n }\n ],\n \"variableBindings\": [\n {\n \"mergeFieldKey\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"mergeFields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"order\": 1,\n \"description\": \"<string>\",\n \"source\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"isRequired\": true\n }\n ]\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
{
"data": {
"templateId": "<string>",
"warnings": [
"<string>"
]
}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}Templates
Update a template
Patches the template’s core fields. Passing roles, questions, or mergeFields replaces those collections wholesale; omit them to leave the existing set alone.
PATCH
/
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 '
{
"name": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"reminderDaysAfterSend": 1,
"expirationDays": 1,
"expiryWarningDays": 1,
"emailSubject": "<string>",
"emailMessage": "<string>",
"lockDocuments": true,
"lockRoles": true,
"lockFields": true,
"brandColor": "<string>",
"roles": [
{
"name": "<string>",
"order": 1
}
],
"questions": [
{
"question": "<string>",
"order": 1,
"dependsOnQuestionIndex": 1,
"dependsOnOptionIndex": 1,
"options": [
{
"label": "<string>",
"order": 1,
"isDefault": true,
"actions": [
{
"targetDocumentId": "<string>",
"targetFieldId": "<string>"
}
],
"regionEffects": [
{
"regionId": "<string>",
"variantId": "<string>"
}
],
"variableBindings": [
{
"mergeFieldKey": "<string>",
"value": "<string>"
}
]
}
]
}
],
"mergeFields": [
{
"key": "<string>",
"label": "<string>",
"order": 1,
"description": "<string>",
"source": "<string>",
"defaultValue": "<string>",
"isRequired": true
}
]
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
tags: ['<string>'],
reminderDaysAfterSend: 1,
expirationDays: 1,
expiryWarningDays: 1,
emailSubject: '<string>',
emailMessage: '<string>',
lockDocuments: true,
lockRoles: true,
lockFields: true,
brandColor: '<string>',
roles: [{name: '<string>', order: 1}],
questions: [
{
question: '<string>',
order: 1,
dependsOnQuestionIndex: 1,
dependsOnOptionIndex: 1,
options: [
{
label: '<string>',
order: 1,
isDefault: true,
actions: [{targetDocumentId: '<string>', targetFieldId: '<string>'}],
regionEffects: [{regionId: '<string>', variantId: '<string>'}],
variableBindings: [{mergeFieldKey: '<string>', value: '<string>'}]
}
]
}
],
mergeFields: [
{
key: '<string>',
label: '<string>',
order: 1,
description: '<string>',
source: '<string>',
defaultValue: '<string>',
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));import requests
url = "https://my.flowsign.app/api/v1/templates/{templateId}"
payload = {
"name": "<string>",
"description": "<string>",
"tags": ["<string>"],
"reminderDaysAfterSend": 1,
"expirationDays": 1,
"expiryWarningDays": 1,
"emailSubject": "<string>",
"emailMessage": "<string>",
"lockDocuments": True,
"lockRoles": True,
"lockFields": True,
"brandColor": "<string>",
"roles": [
{
"name": "<string>",
"order": 1
}
],
"questions": [
{
"question": "<string>",
"order": 1,
"dependsOnQuestionIndex": 1,
"dependsOnOptionIndex": 1,
"options": [
{
"label": "<string>",
"order": 1,
"isDefault": True,
"actions": [
{
"targetDocumentId": "<string>",
"targetFieldId": "<string>"
}
],
"regionEffects": [
{
"regionId": "<string>",
"variantId": "<string>"
}
],
"variableBindings": [
{
"mergeFieldKey": "<string>",
"value": "<string>"
}
]
}
]
}
],
"mergeFields": [
{
"key": "<string>",
"label": "<string>",
"order": 1,
"description": "<string>",
"source": "<string>",
"defaultValue": "<string>",
"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\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"reminderDaysAfterSend\": 1,\n \"expirationDays\": 1,\n \"expiryWarningDays\": 1,\n \"emailSubject\": \"<string>\",\n \"emailMessage\": \"<string>\",\n \"lockDocuments\": true,\n \"lockRoles\": true,\n \"lockFields\": true,\n \"brandColor\": \"<string>\",\n \"roles\": [\n {\n \"name\": \"<string>\",\n \"order\": 1\n }\n ],\n \"questions\": [\n {\n \"question\": \"<string>\",\n \"order\": 1,\n \"dependsOnQuestionIndex\": 1,\n \"dependsOnOptionIndex\": 1,\n \"options\": [\n {\n \"label\": \"<string>\",\n \"order\": 1,\n \"isDefault\": true,\n \"actions\": [\n {\n \"targetDocumentId\": \"<string>\",\n \"targetFieldId\": \"<string>\"\n }\n ],\n \"regionEffects\": [\n {\n \"regionId\": \"<string>\",\n \"variantId\": \"<string>\"\n }\n ],\n \"variableBindings\": [\n {\n \"mergeFieldKey\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n }\n ],\n \"mergeFields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"order\": 1,\n \"description\": \"<string>\",\n \"source\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"isRequired\": true\n }\n ]\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
{
"data": {
"templateId": "<string>",
"warnings": [
"<string>"
]
}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The workspace to act in, from GET /api/v1/workspaces. Omit to act in the organisation's default workspace. A workspace the key's user cannot act in is treated as omitted.
Path Parameters
Body
application/json
Minimum string length:
1Available options:
DRAFT, ACTIVE, ARCHIVED Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Available options:
PARALLEL, SEQUENTIAL, WORKFLOW Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Success
Show child attributes
Show child attributes
Was this page helpful?

