Create and send an eForm or eForm stack
curl --request POST \
--url https://anzapi.onboardme.app/api/v1/eforms \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"templateId": 123,
"name": "<string>",
"schema": null,
"entityKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipientName": "<string>",
"recipientEmail": "<string>",
"recipientMobile": "<string>",
"sendSms": true,
"emailSubject": "<string>",
"emailContent": "<string>",
"mute": true,
"sendNow": true,
"applyMergeFields": true,
"forms": [
{
"templateId": 123,
"name": "<string>",
"schema": null
}
]
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/eforms"
payload = {
"templateId": 123,
"name": "<string>",
"schema": None,
"entityKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipientName": "<string>",
"recipientEmail": "<string>",
"recipientMobile": "<string>",
"sendSms": True,
"emailSubject": "<string>",
"emailContent": "<string>",
"mute": True,
"sendNow": True,
"applyMergeFields": True,
"forms": [
{
"templateId": 123,
"name": "<string>",
"schema": None
}
]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
templateId: 123,
name: '<string>',
schema: null,
entityKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
recipientName: '<string>',
recipientEmail: '<string>',
recipientMobile: '<string>',
sendSms: true,
emailSubject: '<string>',
emailContent: '<string>',
mute: true,
sendNow: true,
applyMergeFields: true,
forms: [{templateId: 123, name: '<string>', schema: null}]
})
};
fetch('https://anzapi.onboardme.app/api/v1/eforms', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'templateId' => 123,
'name' => '<string>',
'schema' => null,
'entityKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'recipientName' => '<string>',
'recipientEmail' => '<string>',
'recipientMobile' => '<string>',
'sendSms' => true,
'emailSubject' => '<string>',
'emailContent' => '<string>',
'mute' => true,
'sendNow' => true,
'applyMergeFields' => true,
'forms' => [
[
'templateId' => 123,
'name' => '<string>',
'schema' => null
]
]
]),
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"
payload := strings.NewReader("{\n \"templateId\": 123,\n \"name\": \"<string>\",\n \"schema\": null,\n \"entityKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipientName\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"recipientMobile\": \"<string>\",\n \"sendSms\": true,\n \"emailSubject\": \"<string>\",\n \"emailContent\": \"<string>\",\n \"mute\": true,\n \"sendNow\": true,\n \"applyMergeFields\": true,\n \"forms\": [\n {\n \"templateId\": 123,\n \"name\": \"<string>\",\n \"schema\": null\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://anzapi.onboardme.app/api/v1/eforms")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"templateId\": 123,\n \"name\": \"<string>\",\n \"schema\": null,\n \"entityKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipientName\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"recipientMobile\": \"<string>\",\n \"sendSms\": true,\n \"emailSubject\": \"<string>\",\n \"emailContent\": \"<string>\",\n \"mute\": true,\n \"sendNow\": true,\n \"applyMergeFields\": true,\n \"forms\": [\n {\n \"templateId\": 123,\n \"name\": \"<string>\",\n \"schema\": null\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/eforms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"templateId\": 123,\n \"name\": \"<string>\",\n \"schema\": null,\n \"entityKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipientName\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"recipientMobile\": \"<string>\",\n \"sendSms\": true,\n \"emailSubject\": \"<string>\",\n \"emailContent\": \"<string>\",\n \"mute\": true,\n \"sendNow\": true,\n \"applyMergeFields\": true,\n \"forms\": [\n {\n \"templateId\": 123,\n \"name\": \"<string>\",\n \"schema\": null\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"formKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stackKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accessUrl": "<string>",
"sent": true,
"emailSent": true,
"forms": [
{
"formKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"stackPosition": 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>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}eForms
Create and send an eForm or eForm stack
Create an eForm from a template, a custom schema, or a stack of templates, and optionally send it.
POST
/
api
/
v1
/
eforms
Create and send an eForm or eForm stack
curl --request POST \
--url https://anzapi.onboardme.app/api/v1/eforms \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"templateId": 123,
"name": "<string>",
"schema": null,
"entityKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipientName": "<string>",
"recipientEmail": "<string>",
"recipientMobile": "<string>",
"sendSms": true,
"emailSubject": "<string>",
"emailContent": "<string>",
"mute": true,
"sendNow": true,
"applyMergeFields": true,
"forms": [
{
"templateId": 123,
"name": "<string>",
"schema": null
}
]
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/eforms"
payload = {
"templateId": 123,
"name": "<string>",
"schema": None,
"entityKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipientName": "<string>",
"recipientEmail": "<string>",
"recipientMobile": "<string>",
"sendSms": True,
"emailSubject": "<string>",
"emailContent": "<string>",
"mute": True,
"sendNow": True,
"applyMergeFields": True,
"forms": [
{
"templateId": 123,
"name": "<string>",
"schema": None
}
]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
templateId: 123,
name: '<string>',
schema: null,
entityKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
recipientName: '<string>',
recipientEmail: '<string>',
recipientMobile: '<string>',
sendSms: true,
emailSubject: '<string>',
emailContent: '<string>',
mute: true,
sendNow: true,
applyMergeFields: true,
forms: [{templateId: 123, name: '<string>', schema: null}]
})
};
fetch('https://anzapi.onboardme.app/api/v1/eforms', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'templateId' => 123,
'name' => '<string>',
'schema' => null,
'entityKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'recipientName' => '<string>',
'recipientEmail' => '<string>',
'recipientMobile' => '<string>',
'sendSms' => true,
'emailSubject' => '<string>',
'emailContent' => '<string>',
'mute' => true,
'sendNow' => true,
'applyMergeFields' => true,
'forms' => [
[
'templateId' => 123,
'name' => '<string>',
'schema' => null
]
]
]),
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"
payload := strings.NewReader("{\n \"templateId\": 123,\n \"name\": \"<string>\",\n \"schema\": null,\n \"entityKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipientName\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"recipientMobile\": \"<string>\",\n \"sendSms\": true,\n \"emailSubject\": \"<string>\",\n \"emailContent\": \"<string>\",\n \"mute\": true,\n \"sendNow\": true,\n \"applyMergeFields\": true,\n \"forms\": [\n {\n \"templateId\": 123,\n \"name\": \"<string>\",\n \"schema\": null\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://anzapi.onboardme.app/api/v1/eforms")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"templateId\": 123,\n \"name\": \"<string>\",\n \"schema\": null,\n \"entityKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipientName\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"recipientMobile\": \"<string>\",\n \"sendSms\": true,\n \"emailSubject\": \"<string>\",\n \"emailContent\": \"<string>\",\n \"mute\": true,\n \"sendNow\": true,\n \"applyMergeFields\": true,\n \"forms\": [\n {\n \"templateId\": 123,\n \"name\": \"<string>\",\n \"schema\": null\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/eforms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"templateId\": 123,\n \"name\": \"<string>\",\n \"schema\": null,\n \"entityKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipientName\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"recipientMobile\": \"<string>\",\n \"sendSms\": true,\n \"emailSubject\": \"<string>\",\n \"emailContent\": \"<string>\",\n \"mute\": true,\n \"sendNow\": true,\n \"applyMergeFields\": true,\n \"forms\": [\n {\n \"templateId\": 123,\n \"name\": \"<string>\",\n \"schema\": null\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"formKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stackKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accessUrl": "<string>",
"sent": true,
"emailSent": true,
"forms": [
{
"formKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"stackPosition": 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>"
}{
"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.
Body
application/jsontext/jsonapplication/*+json
Show child attributes
Show child attributes