curl --request POST \
--url https://production-api.joinrings.com/v1/persons/{person_uuid}/merge \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"superseded_uuid": "<string>",
"preview": false,
"reason": "<string>"
}
'import requests
url = "https://production-api.joinrings.com/v1/persons/{person_uuid}/merge"
payload = {
"superseded_uuid": "<string>",
"preview": False,
"reason": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({superseded_uuid: '<string>', preview: false, reason: '<string>'})
};
fetch('https://production-api.joinrings.com/v1/persons/{person_uuid}/merge', 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://production-api.joinrings.com/v1/persons/{person_uuid}/merge",
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([
'superseded_uuid' => '<string>',
'preview' => false,
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://production-api.joinrings.com/v1/persons/{person_uuid}/merge"
payload := strings.NewReader("{\n \"superseded_uuid\": \"<string>\",\n \"preview\": false,\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://production-api.joinrings.com/v1/persons/{person_uuid}/merge")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"superseded_uuid\": \"<string>\",\n \"preview\": false,\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/persons/{person_uuid}/merge")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"superseded_uuid\": \"<string>\",\n \"preview\": false,\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"canonical_uuid": "<string>",
"merge_version": 123,
"superseded_uuid": "<string>",
"audit_id": 123,
"preview": {},
"rewrite_counts": {}
}Merge persons
Always tenant-scoped to the caller’s own tenant — there is no REST
option for GLOBAL scope or admin overrides. Set preview=true for a
read-only dry run: nothing persists, and the response’s preview
field describes the canonical/superseded/merged entities as they
would look post-merge. Returns 404 if either UUID doesn’t exist, 409
if the two UUIDs are already merged (or identical), and 400 for
other merge validation errors.
curl --request POST \
--url https://production-api.joinrings.com/v1/persons/{person_uuid}/merge \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"superseded_uuid": "<string>",
"preview": false,
"reason": "<string>"
}
'import requests
url = "https://production-api.joinrings.com/v1/persons/{person_uuid}/merge"
payload = {
"superseded_uuid": "<string>",
"preview": False,
"reason": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({superseded_uuid: '<string>', preview: false, reason: '<string>'})
};
fetch('https://production-api.joinrings.com/v1/persons/{person_uuid}/merge', 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://production-api.joinrings.com/v1/persons/{person_uuid}/merge",
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([
'superseded_uuid' => '<string>',
'preview' => false,
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://production-api.joinrings.com/v1/persons/{person_uuid}/merge"
payload := strings.NewReader("{\n \"superseded_uuid\": \"<string>\",\n \"preview\": false,\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://production-api.joinrings.com/v1/persons/{person_uuid}/merge")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"superseded_uuid\": \"<string>\",\n \"preview\": false,\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/persons/{person_uuid}/merge")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"superseded_uuid\": \"<string>\",\n \"preview\": false,\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"canonical_uuid": "<string>",
"merge_version": 123,
"superseded_uuid": "<string>",
"audit_id": 123,
"preview": {},
"rewrite_counts": {}
}Authorizations
Path Parameters
Response
Response body for POST /v1/persons/{uuid}/merge.
rewrite_counts mirrors whatever the merge engine reports for this
merge (row counts per rewritten table); its keys are not a fixed set.
preview is only populated when the request had preview=true -- a
read-only dry-run description of the canonical/superseded/merged
entities; nothing is persisted in that case.