Add a practice user
curl --request POST \
--url https://anzapi.onboardme.app/api/v1/users \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"mobileNumber": "<string>",
"roleName": "<string>",
"roleId": 123,
"enable2FA": true,
"meetingLink": "<string>",
"baseUrl": "<string>"
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/users"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"mobileNumber": "<string>",
"roleName": "<string>",
"roleId": 123,
"enable2FA": True,
"meetingLink": "<string>",
"baseUrl": "<string>"
}
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({
firstName: '<string>',
lastName: '<string>',
email: '<string>',
mobileNumber: '<string>',
roleName: '<string>',
roleId: 123,
enable2FA: true,
meetingLink: '<string>',
baseUrl: '<string>'
})
};
fetch('https://anzapi.onboardme.app/api/v1/users', 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/users",
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([
'firstName' => '<string>',
'lastName' => '<string>',
'email' => '<string>',
'mobileNumber' => '<string>',
'roleName' => '<string>',
'roleId' => 123,
'enable2FA' => true,
'meetingLink' => '<string>',
'baseUrl' => '<string>'
]),
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/users"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"mobileNumber\": \"<string>\",\n \"roleName\": \"<string>\",\n \"roleId\": 123,\n \"enable2FA\": true,\n \"meetingLink\": \"<string>\",\n \"baseUrl\": \"<string>\"\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/users")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"mobileNumber\": \"<string>\",\n \"roleName\": \"<string>\",\n \"roleId\": 123,\n \"enable2FA\": true,\n \"meetingLink\": \"<string>\",\n \"baseUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/users")
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 \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"mobileNumber\": \"<string>\",\n \"roleName\": \"<string>\",\n \"roleId\": 123,\n \"enable2FA\": true,\n \"meetingLink\": \"<string>\",\n \"baseUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"isBrandNewUser": true,
"createdMembership": 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>"
}Users
Add a practice user
Add a practice user.
POST
/
api
/
v1
/
users
Add a practice user
curl --request POST \
--url https://anzapi.onboardme.app/api/v1/users \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"mobileNumber": "<string>",
"roleName": "<string>",
"roleId": 123,
"enable2FA": true,
"meetingLink": "<string>",
"baseUrl": "<string>"
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/users"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"mobileNumber": "<string>",
"roleName": "<string>",
"roleId": 123,
"enable2FA": True,
"meetingLink": "<string>",
"baseUrl": "<string>"
}
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({
firstName: '<string>',
lastName: '<string>',
email: '<string>',
mobileNumber: '<string>',
roleName: '<string>',
roleId: 123,
enable2FA: true,
meetingLink: '<string>',
baseUrl: '<string>'
})
};
fetch('https://anzapi.onboardme.app/api/v1/users', 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/users",
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([
'firstName' => '<string>',
'lastName' => '<string>',
'email' => '<string>',
'mobileNumber' => '<string>',
'roleName' => '<string>',
'roleId' => 123,
'enable2FA' => true,
'meetingLink' => '<string>',
'baseUrl' => '<string>'
]),
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/users"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"mobileNumber\": \"<string>\",\n \"roleName\": \"<string>\",\n \"roleId\": 123,\n \"enable2FA\": true,\n \"meetingLink\": \"<string>\",\n \"baseUrl\": \"<string>\"\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/users")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"mobileNumber\": \"<string>\",\n \"roleName\": \"<string>\",\n \"roleId\": 123,\n \"enable2FA\": true,\n \"meetingLink\": \"<string>\",\n \"baseUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/users")
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 \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"mobileNumber\": \"<string>\",\n \"roleName\": \"<string>\",\n \"roleId\": 123,\n \"enable2FA\": true,\n \"meetingLink\": \"<string>\",\n \"baseUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"isBrandNewUser": true,
"createdMembership": 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