Skip to main content
POST
/
api
/
admin
/
users
/
merge
Merge a source user into a target user
curl --request POST \
  --url https://pria.praxislxp.com/api/admin/users/merge \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "sourceUserId": "<string>",
  "targetUserId": "<string>",
  "dryRun": false,
  "confirm": true
}
'
import requests

url = "https://pria.praxislxp.com/api/admin/users/merge"

payload = {
"sourceUserId": "<string>",
"targetUserId": "<string>",
"dryRun": False,
"confirm": True
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sourceUserId: '<string>',
targetUserId: '<string>',
dryRun: false,
confirm: true
})
};

fetch('https://pria.praxislxp.com/api/admin/users/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://pria.praxislxp.com/api/admin/users/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([
'sourceUserId' => '<string>',
'targetUserId' => '<string>',
'dryRun' => false,
'confirm' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <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://pria.praxislxp.com/api/admin/users/merge"

payload := strings.NewReader("{\n \"sourceUserId\": \"<string>\",\n \"targetUserId\": \"<string>\",\n \"dryRun\": false,\n \"confirm\": true\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-access-token", "<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://pria.praxislxp.com/api/admin/users/merge")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sourceUserId\": \"<string>\",\n \"targetUserId\": \"<string>\",\n \"dryRun\": false,\n \"confirm\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://pria.praxislxp.com/api/admin/users/merge")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sourceUserId\": \"<string>\",\n \"targetUserId\": \"<string>\",\n \"dryRun\": false,\n \"confirm\": true\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "summary": {}
}

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
sourceUserId
string
required

The user to merge FROM. Hard-deleted on a successful apply; must not be a super-admin.

targetUserId
string
required

The user to merge INTO (survives). Every ref:'user' on the source is repointed here.

dryRun
boolean
default:false

When true, returns the preview (per-collection counts + conflicts) and writes nothing.

confirm
boolean

Required (true) to APPLY a merge (when dryRun is not true). Forces dry-run-then-confirm.

Response

Preview (dryRun) or merge result

success
boolean
mode
enum<string>
Available options:
merge,
dryRun
summary
object

On dryRun: the preview. On apply: { success, repointed, institutions, credits, auditId }.