Update an eForm template
curl --request PUT \
--url https://anzapi.onboardme.app/api/v1/eforms/templates/{templateId} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"formTypeID": 123,
"schema": "<unknown>",
"emailSubject": "<string>",
"emailContent": "<string>",
"inactive": true
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/eforms/templates/{templateId}"
payload = {
"name": "<string>",
"description": "<string>",
"formTypeID": 123,
"schema": "<unknown>",
"emailSubject": "<string>",
"emailContent": "<string>",
"inactive": True
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
formTypeID: 123,
schema: '<unknown>',
emailSubject: '<string>',
emailContent: '<string>',
inactive: true
})
};
fetch('https://anzapi.onboardme.app/api/v1/eforms/templates/{templateId}', 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://anzapi.onboardme.app/api/v1/eforms/templates/{templateId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'formTypeID' => 123,
'schema' => '<unknown>',
'emailSubject' => '<string>',
'emailContent' => '<string>',
'inactive' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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://anzapi.onboardme.app/api/v1/eforms/templates/{templateId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"formTypeID\": 123,\n \"schema\": \"<unknown>\",\n \"emailSubject\": \"<string>\",\n \"emailContent\": \"<string>\",\n \"inactive\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.put("https://anzapi.onboardme.app/api/v1/eforms/templates/{templateId}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"formTypeID\": 123,\n \"schema\": \"<unknown>\",\n \"emailSubject\": \"<string>\",\n \"emailContent\": \"<string>\",\n \"inactive\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/eforms/templates/{templateId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"formTypeID\": 123,\n \"schema\": \"<unknown>\",\n \"emailSubject\": \"<string>\",\n \"emailContent\": \"<string>\",\n \"inactive\": true\n}"
response = http.request(request)
puts response.read_body{
"templateId": 123,
"savedAsPracticeCopy": true,
"questionCount": 123
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}eForms
Update an eForm template
Update an eForm template’s name or schema.
PUT
/
api
/
v1
/
eforms
/
templates
/
{templateId}
Update an eForm template
curl --request PUT \
--url https://anzapi.onboardme.app/api/v1/eforms/templates/{templateId} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"formTypeID": 123,
"schema": "<unknown>",
"emailSubject": "<string>",
"emailContent": "<string>",
"inactive": true
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/eforms/templates/{templateId}"
payload = {
"name": "<string>",
"description": "<string>",
"formTypeID": 123,
"schema": "<unknown>",
"emailSubject": "<string>",
"emailContent": "<string>",
"inactive": True
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
formTypeID: 123,
schema: '<unknown>',
emailSubject: '<string>',
emailContent: '<string>',
inactive: true
})
};
fetch('https://anzapi.onboardme.app/api/v1/eforms/templates/{templateId}', 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://anzapi.onboardme.app/api/v1/eforms/templates/{templateId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'formTypeID' => 123,
'schema' => '<unknown>',
'emailSubject' => '<string>',
'emailContent' => '<string>',
'inactive' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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://anzapi.onboardme.app/api/v1/eforms/templates/{templateId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"formTypeID\": 123,\n \"schema\": \"<unknown>\",\n \"emailSubject\": \"<string>\",\n \"emailContent\": \"<string>\",\n \"inactive\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.put("https://anzapi.onboardme.app/api/v1/eforms/templates/{templateId}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"formTypeID\": 123,\n \"schema\": \"<unknown>\",\n \"emailSubject\": \"<string>\",\n \"emailContent\": \"<string>\",\n \"inactive\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/eforms/templates/{templateId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"formTypeID\": 123,\n \"schema\": \"<unknown>\",\n \"emailSubject\": \"<string>\",\n \"emailContent\": \"<string>\",\n \"inactive\": true\n}"
response = http.request(request)
puts response.read_body{
"templateId": 123,
"savedAsPracticeCopy": true,
"questionCount": 123
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
Swagger / Postman only: Client ID as username, Client secret as password. In Postman, set this once on the collection (Authorization → Basic Auth) so all requests inherit. For production server-to-server code, prefer X-OM-Auth-ID and X-OM-Auth-Key headers.
Path Parameters
Body
application/jsontext/jsonapplication/*+json