Create and send an eForm from a template
curl --request POST \
--url https://anzapi.onboardme.app/api/v1/eforms/send \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"templateId": 123,
"entityKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipientName": "<string>",
"recipientEmail": "<string>",
"recipientMobile": "<string>",
"mute": true
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/eforms/send"
payload = {
"templateId": 123,
"entityKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipientName": "<string>",
"recipientEmail": "<string>",
"recipientMobile": "<string>",
"mute": True
}
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,
entityKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
recipientName: '<string>',
recipientEmail: '<string>',
recipientMobile: '<string>',
mute: true
})
};
fetch('https://anzapi.onboardme.app/api/v1/eforms/send', 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/send",
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,
'entityKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'recipientName' => '<string>',
'recipientEmail' => '<string>',
'recipientMobile' => '<string>',
'mute' => 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/send"
payload := strings.NewReader("{\n \"templateId\": 123,\n \"entityKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipientName\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"recipientMobile\": \"<string>\",\n \"mute\": true\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/send")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"templateId\": 123,\n \"entityKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipientName\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"recipientMobile\": \"<string>\",\n \"mute\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/eforms/send")
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 \"entityKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipientName\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"recipientMobile\": \"<string>\",\n \"mute\": true\n}"
response = http.request(request)
puts response.read_body{
"formKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accessUrl": "<string>",
"emailSent": true,
"sent": true
}{
"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
Creates an eForm from a template (templateId from GET /api/v1/eforms/templates), then sends the invitation email.
Recipient
entityKey— reference an existing client. You may overriderecipientName,recipientEmail, orrecipientMobilefor this send only.- Omit
entityKeyand supplyrecipientNameandrecipientEmail(and optionallyrecipientMobile) for a recipient not tied to a stored client (entityIdis left unset).
mute — when true, no email is sent; the form is still marked as sent and accessUrl is the same client link as when the email would have been sent (compare ID verification mute).
If the send step fails (for example mail delivery), the form is left as a draft and sent is false; accessUrl is then a portal URL to open the form in the editor.
Insufficient subscription or wallet balance returns 400 (no charge). Write access is required.
429 — rate limit exceeded.
POST
/
api
/
v1
/
eforms
/
send
Create and send an eForm from a template
curl --request POST \
--url https://anzapi.onboardme.app/api/v1/eforms/send \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"templateId": 123,
"entityKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipientName": "<string>",
"recipientEmail": "<string>",
"recipientMobile": "<string>",
"mute": true
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/eforms/send"
payload = {
"templateId": 123,
"entityKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipientName": "<string>",
"recipientEmail": "<string>",
"recipientMobile": "<string>",
"mute": True
}
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,
entityKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
recipientName: '<string>',
recipientEmail: '<string>',
recipientMobile: '<string>',
mute: true
})
};
fetch('https://anzapi.onboardme.app/api/v1/eforms/send', 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/send",
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,
'entityKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'recipientName' => '<string>',
'recipientEmail' => '<string>',
'recipientMobile' => '<string>',
'mute' => 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/send"
payload := strings.NewReader("{\n \"templateId\": 123,\n \"entityKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipientName\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"recipientMobile\": \"<string>\",\n \"mute\": true\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/send")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"templateId\": 123,\n \"entityKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipientName\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"recipientMobile\": \"<string>\",\n \"mute\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/eforms/send")
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 \"entityKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipientName\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"recipientMobile\": \"<string>\",\n \"mute\": true\n}"
response = http.request(request)
puts response.read_body{
"formKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accessUrl": "<string>",
"emailSent": true,
"sent": true
}{
"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