Catalog
Update a template
Partial update of an active template. The slug is frozen — renaming changes only the display name, never the address. columns is a full replacement of the column set when present; cross-cell rules stored on the template are always preserved. Edits are refused with 409 while a migration that uses the template is running. grouping organises the template list in the dashboard and is not returned by template reads.
PATCH
/
templates
/
{template_slug}
Update a template
curl --request PATCH \
--url https://app.vern.so/api/v1/templates/{template_slug} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"description": "Suppliers master list. One row per active supplier.",
"columns": [
{
"name": "Supplier Name",
"description": "Legal entity name",
"required": true
},
{
"name": "ABN",
"description": "Australian Business Number",
"required": false,
"desiredRule": "strict",
"strictRule": "^\\d{11}$"
}
]
}
'import requests
url = "https://app.vern.so/api/v1/templates/{template_slug}"
payload = {
"description": "Suppliers master list. One row per active supplier.",
"columns": [
{
"name": "Supplier Name",
"description": "Legal entity name",
"required": True
},
{
"name": "ABN",
"description": "Australian Business Number",
"required": False,
"desiredRule": "strict",
"strictRule": "^\d{11}$"
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: 'Suppliers master list. One row per active supplier.',
columns: [
{name: 'Supplier Name', description: 'Legal entity name', required: true},
{
name: 'ABN',
description: 'Australian Business Number',
required: false,
desiredRule: 'strict',
strictRule: '^\d{11}$'
}
]
})
};
fetch('https://app.vern.so/api/v1/templates/{template_slug}', 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://app.vern.so/api/v1/templates/{template_slug}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => 'Suppliers master list. One row per active supplier.',
'columns' => [
[
'name' => 'Supplier Name',
'description' => 'Legal entity name',
'required' => true
],
[
'name' => 'ABN',
'description' => 'Australian Business Number',
'required' => false,
'desiredRule' => 'strict',
'strictRule' => '^\\d{11}$'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://app.vern.so/api/v1/templates/{template_slug}"
payload := strings.NewReader("{\n \"description\": \"Suppliers master list. One row per active supplier.\",\n \"columns\": [\n {\n \"name\": \"Supplier Name\",\n \"description\": \"Legal entity name\",\n \"required\": true\n },\n {\n \"name\": \"ABN\",\n \"description\": \"Australian Business Number\",\n \"required\": false,\n \"desiredRule\": \"strict\",\n \"strictRule\": \"^\\\\d{11}$\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.patch("https://app.vern.so/api/v1/templates/{template_slug}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Suppliers master list. One row per active supplier.\",\n \"columns\": [\n {\n \"name\": \"Supplier Name\",\n \"description\": \"Legal entity name\",\n \"required\": true\n },\n {\n \"name\": \"ABN\",\n \"description\": \"Australian Business Number\",\n \"required\": false,\n \"desiredRule\": \"strict\",\n \"strictRule\": \"^\\\\d{11}$\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.vern.so/api/v1/templates/{template_slug}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"Suppliers master list. One row per active supplier.\",\n \"columns\": [\n {\n \"name\": \"Supplier Name\",\n \"description\": \"Legal entity name\",\n \"required\": true\n },\n {\n \"name\": \"ABN\",\n \"description\": \"Australian Business Number\",\n \"required\": false,\n \"desiredRule\": \"strict\",\n \"strictRule\": \"^\\\\d{11}$\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"columns": [
{
"name": "<string>",
"description": "<string>",
"required": true,
"unique": true,
"desiredRule": "none",
"strictRule": "<string>",
"linkRule": [
{
"templateId": "<string>",
"columnName": "<string>"
}
]
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Too many requests"
}Authorizations
Your Vern API key. Create one at Settings → API keys.
Path Parameters
Body
application/json
New display name. Does not change the slug.
The template's knowledge / description. null clears it.
Free-text group label for the dashboard. null clears it.
Full replacement of the column set.
Minimum array length:
1Show child attributes
Show child attributes
⌘I
Update a template
curl --request PATCH \
--url https://app.vern.so/api/v1/templates/{template_slug} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"description": "Suppliers master list. One row per active supplier.",
"columns": [
{
"name": "Supplier Name",
"description": "Legal entity name",
"required": true
},
{
"name": "ABN",
"description": "Australian Business Number",
"required": false,
"desiredRule": "strict",
"strictRule": "^\\d{11}$"
}
]
}
'import requests
url = "https://app.vern.so/api/v1/templates/{template_slug}"
payload = {
"description": "Suppliers master list. One row per active supplier.",
"columns": [
{
"name": "Supplier Name",
"description": "Legal entity name",
"required": True
},
{
"name": "ABN",
"description": "Australian Business Number",
"required": False,
"desiredRule": "strict",
"strictRule": "^\d{11}$"
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: 'Suppliers master list. One row per active supplier.',
columns: [
{name: 'Supplier Name', description: 'Legal entity name', required: true},
{
name: 'ABN',
description: 'Australian Business Number',
required: false,
desiredRule: 'strict',
strictRule: '^\d{11}$'
}
]
})
};
fetch('https://app.vern.so/api/v1/templates/{template_slug}', 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://app.vern.so/api/v1/templates/{template_slug}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => 'Suppliers master list. One row per active supplier.',
'columns' => [
[
'name' => 'Supplier Name',
'description' => 'Legal entity name',
'required' => true
],
[
'name' => 'ABN',
'description' => 'Australian Business Number',
'required' => false,
'desiredRule' => 'strict',
'strictRule' => '^\\d{11}$'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://app.vern.so/api/v1/templates/{template_slug}"
payload := strings.NewReader("{\n \"description\": \"Suppliers master list. One row per active supplier.\",\n \"columns\": [\n {\n \"name\": \"Supplier Name\",\n \"description\": \"Legal entity name\",\n \"required\": true\n },\n {\n \"name\": \"ABN\",\n \"description\": \"Australian Business Number\",\n \"required\": false,\n \"desiredRule\": \"strict\",\n \"strictRule\": \"^\\\\d{11}$\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.patch("https://app.vern.so/api/v1/templates/{template_slug}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Suppliers master list. One row per active supplier.\",\n \"columns\": [\n {\n \"name\": \"Supplier Name\",\n \"description\": \"Legal entity name\",\n \"required\": true\n },\n {\n \"name\": \"ABN\",\n \"description\": \"Australian Business Number\",\n \"required\": false,\n \"desiredRule\": \"strict\",\n \"strictRule\": \"^\\\\d{11}$\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.vern.so/api/v1/templates/{template_slug}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"Suppliers master list. One row per active supplier.\",\n \"columns\": [\n {\n \"name\": \"Supplier Name\",\n \"description\": \"Legal entity name\",\n \"required\": true\n },\n {\n \"name\": \"ABN\",\n \"description\": \"Australian Business Number\",\n \"required\": false,\n \"desiredRule\": \"strict\",\n \"strictRule\": \"^\\\\d{11}$\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"columns": [
{
"name": "<string>",
"description": "<string>",
"required": true,
"unique": true,
"desiredRule": "none",
"strictRule": "<string>",
"linkRule": [
{
"templateId": "<string>",
"columnName": "<string>"
}
]
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Too many requests"
}