Edit onboarding recipients
curl --request PATCH \
--url https://anzapi.onboardme.app/api/v1/onboardings/{key}/recipients \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipients": [
{
"recipientKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"remove": true,
"name": "<string>",
"surname": "<string>",
"email": "<string>",
"mobile": "<string>",
"sendSms": true,
"access": [
{
"entityOnboardingId": 123,
"canEdit": true
}
]
}
]
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/onboardings/{key}/recipients"
payload = {
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipients": [
{
"recipientKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"remove": True,
"name": "<string>",
"surname": "<string>",
"email": "<string>",
"mobile": "<string>",
"sendSms": True,
"access": [
{
"entityOnboardingId": 123,
"canEdit": True
}
]
}
]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
recipients: [
{
recipientKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
remove: true,
name: '<string>',
surname: '<string>',
email: '<string>',
mobile: '<string>',
sendSms: true,
access: [{entityOnboardingId: 123, canEdit: true}]
}
]
})
};
fetch('https://anzapi.onboardme.app/api/v1/onboardings/{key}/recipients', 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/onboardings/{key}/recipients",
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([
'userKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'recipients' => [
[
'recipientKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'remove' => true,
'name' => '<string>',
'surname' => '<string>',
'email' => '<string>',
'mobile' => '<string>',
'sendSms' => true,
'access' => [
[
'entityOnboardingId' => 123,
'canEdit' => 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/onboardings/{key}/recipients"
payload := strings.NewReader("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipients\": [\n {\n \"recipientKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"remove\": true,\n \"name\": \"<string>\",\n \"surname\": \"<string>\",\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"sendSms\": true,\n \"access\": [\n {\n \"entityOnboardingId\": 123,\n \"canEdit\": true\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://anzapi.onboardme.app/api/v1/onboardings/{key}/recipients")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipients\": [\n {\n \"recipientKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"remove\": true,\n \"name\": \"<string>\",\n \"surname\": \"<string>\",\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"sendSms\": true,\n \"access\": [\n {\n \"entityOnboardingId\": 123,\n \"canEdit\": true\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/onboardings/{key}/recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipients\": [\n {\n \"recipientKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"remove\": true,\n \"name\": \"<string>\",\n \"surname\": \"<string>\",\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"sendSms\": true,\n \"access\": [\n {\n \"entityOnboardingId\": 123,\n \"canEdit\": true\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyOnboarding management
Edit onboarding recipients
Add, change or remove individual recipients on an onboarding.
PATCH
/
api
/
v1
/
onboardings
/
{key}
/
recipients
Edit onboarding recipients
curl --request PATCH \
--url https://anzapi.onboardme.app/api/v1/onboardings/{key}/recipients \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipients": [
{
"recipientKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"remove": true,
"name": "<string>",
"surname": "<string>",
"email": "<string>",
"mobile": "<string>",
"sendSms": true,
"access": [
{
"entityOnboardingId": 123,
"canEdit": true
}
]
}
]
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/onboardings/{key}/recipients"
payload = {
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipients": [
{
"recipientKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"remove": True,
"name": "<string>",
"surname": "<string>",
"email": "<string>",
"mobile": "<string>",
"sendSms": True,
"access": [
{
"entityOnboardingId": 123,
"canEdit": True
}
]
}
]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
recipients: [
{
recipientKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
remove: true,
name: '<string>',
surname: '<string>',
email: '<string>',
mobile: '<string>',
sendSms: true,
access: [{entityOnboardingId: 123, canEdit: true}]
}
]
})
};
fetch('https://anzapi.onboardme.app/api/v1/onboardings/{key}/recipients', 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/onboardings/{key}/recipients",
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([
'userKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'recipients' => [
[
'recipientKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'remove' => true,
'name' => '<string>',
'surname' => '<string>',
'email' => '<string>',
'mobile' => '<string>',
'sendSms' => true,
'access' => [
[
'entityOnboardingId' => 123,
'canEdit' => 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/onboardings/{key}/recipients"
payload := strings.NewReader("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipients\": [\n {\n \"recipientKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"remove\": true,\n \"name\": \"<string>\",\n \"surname\": \"<string>\",\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"sendSms\": true,\n \"access\": [\n {\n \"entityOnboardingId\": 123,\n \"canEdit\": true\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://anzapi.onboardme.app/api/v1/onboardings/{key}/recipients")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipients\": [\n {\n \"recipientKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"remove\": true,\n \"name\": \"<string>\",\n \"surname\": \"<string>\",\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"sendSms\": true,\n \"access\": [\n {\n \"entityOnboardingId\": 123,\n \"canEdit\": true\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/onboardings/{key}/recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"recipients\": [\n {\n \"recipientKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"remove\": true,\n \"name\": \"<string>\",\n \"surname\": \"<string>\",\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"sendSms\": true,\n \"access\": [\n {\n \"entityOnboardingId\": 123,\n \"canEdit\": true\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
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
Response
200
OK