curl --request POST \
--url https://your-instance.example.com/api/contacts/{id}/separate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fieldSplit": {
"firstName": {
"original": "Jane",
"new": "Janet"
},
"lastName": {
"original": "Doe",
"new": "Doe"
},
"status": "original",
"pipelineId": "original",
"pipelineStage": "original",
"assignees": "original",
"outreachConfigId": "original"
},
"childRecordAssignment": {
"conversations": {
"64f0a1b2c3d4e5f6a7b8c9e0": "new"
},
"applications": {},
"contactNotes": {},
"reminders": {},
"trainingSnapshots": {}
}
}
'import requests
url = "https://your-instance.example.com/api/contacts/{id}/separate"
payload = {
"fieldSplit": {
"firstName": {
"original": "Jane",
"new": "Janet"
},
"lastName": {
"original": "Doe",
"new": "Doe"
},
"status": "original",
"pipelineId": "original",
"pipelineStage": "original",
"assignees": "original",
"outreachConfigId": "original"
},
"childRecordAssignment": {
"conversations": { "64f0a1b2c3d4e5f6a7b8c9e0": "new" },
"applications": {},
"contactNotes": {},
"reminders": {},
"trainingSnapshots": {}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
fieldSplit: {
firstName: {original: 'Jane', new: 'Janet'},
lastName: {original: 'Doe', new: 'Doe'},
status: 'original',
pipelineId: 'original',
pipelineStage: 'original',
assignees: 'original',
outreachConfigId: 'original'
},
childRecordAssignment: {
conversations: {'64f0a1b2c3d4e5f6a7b8c9e0': 'new'},
applications: {},
contactNotes: {},
reminders: {},
trainingSnapshots: {}
}
})
};
fetch('https://your-instance.example.com/api/contacts/{id}/separate', 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://your-instance.example.com/api/contacts/{id}/separate",
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([
'fieldSplit' => [
'firstName' => [
'original' => 'Jane',
'new' => 'Janet'
],
'lastName' => [
'original' => 'Doe',
'new' => 'Doe'
],
'status' => 'original',
'pipelineId' => 'original',
'pipelineStage' => 'original',
'assignees' => 'original',
'outreachConfigId' => 'original'
],
'childRecordAssignment' => [
'conversations' => [
'64f0a1b2c3d4e5f6a7b8c9e0' => 'new'
],
'applications' => [
],
'contactNotes' => [
],
'reminders' => [
],
'trainingSnapshots' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://your-instance.example.com/api/contacts/{id}/separate"
payload := strings.NewReader("{\n \"fieldSplit\": {\n \"firstName\": {\n \"original\": \"Jane\",\n \"new\": \"Janet\"\n },\n \"lastName\": {\n \"original\": \"Doe\",\n \"new\": \"Doe\"\n },\n \"status\": \"original\",\n \"pipelineId\": \"original\",\n \"pipelineStage\": \"original\",\n \"assignees\": \"original\",\n \"outreachConfigId\": \"original\"\n },\n \"childRecordAssignment\": {\n \"conversations\": {\n \"64f0a1b2c3d4e5f6a7b8c9e0\": \"new\"\n },\n \"applications\": {},\n \"contactNotes\": {},\n \"reminders\": {},\n \"trainingSnapshots\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://your-instance.example.com/api/contacts/{id}/separate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fieldSplit\": {\n \"firstName\": {\n \"original\": \"Jane\",\n \"new\": \"Janet\"\n },\n \"lastName\": {\n \"original\": \"Doe\",\n \"new\": \"Doe\"\n },\n \"status\": \"original\",\n \"pipelineId\": \"original\",\n \"pipelineStage\": \"original\",\n \"assignees\": \"original\",\n \"outreachConfigId\": \"original\"\n },\n \"childRecordAssignment\": {\n \"conversations\": {\n \"64f0a1b2c3d4e5f6a7b8c9e0\": \"new\"\n },\n \"applications\": {},\n \"contactNotes\": {},\n \"reminders\": {},\n \"trainingSnapshots\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/contacts/{id}/separate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fieldSplit\": {\n \"firstName\": {\n \"original\": \"Jane\",\n \"new\": \"Janet\"\n },\n \"lastName\": {\n \"original\": \"Doe\",\n \"new\": \"Doe\"\n },\n \"status\": \"original\",\n \"pipelineId\": \"original\",\n \"pipelineStage\": \"original\",\n \"assignees\": \"original\",\n \"outreachConfigId\": \"original\"\n },\n \"childRecordAssignment\": {\n \"conversations\": {\n \"64f0a1b2c3d4e5f6a7b8c9e0\": \"new\"\n },\n \"applications\": {},\n \"contactNotes\": {},\n \"reminders\": {},\n \"trainingSnapshots\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"originalContactId": "64f0a1b2c3d4e5f6a7b8c9d0",
"newContactId": "64f0a1b2c3d4e5f6a7b8ca20",
"summary": {
"conversationsMoved": 1,
"applicationsMoved": 0,
"notesMoved": 0,
"remindersMoved": 0,
"trainingSnapshotsMoved": 0,
"messagesReassigned": 4
}
}
}{
"error": "Attachment not found",
"message": "Attachment not found"
}{
"error": "Attachment not found",
"message": "Attachment not found"
}{
"error": "Attachment not found",
"message": "Attachment not found"
}{
"error": "Attachment not found",
"message": "Attachment not found"
}Separate one contact into two
Splits the source contact into two contacts based on a field split and child-record assignment plan. Admin/Superadmin only. Validates phone format, email format, and uniqueness; rejects splits that would violate the per-org phone uniqueness invariant.
curl --request POST \
--url https://your-instance.example.com/api/contacts/{id}/separate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fieldSplit": {
"firstName": {
"original": "Jane",
"new": "Janet"
},
"lastName": {
"original": "Doe",
"new": "Doe"
},
"status": "original",
"pipelineId": "original",
"pipelineStage": "original",
"assignees": "original",
"outreachConfigId": "original"
},
"childRecordAssignment": {
"conversations": {
"64f0a1b2c3d4e5f6a7b8c9e0": "new"
},
"applications": {},
"contactNotes": {},
"reminders": {},
"trainingSnapshots": {}
}
}
'import requests
url = "https://your-instance.example.com/api/contacts/{id}/separate"
payload = {
"fieldSplit": {
"firstName": {
"original": "Jane",
"new": "Janet"
},
"lastName": {
"original": "Doe",
"new": "Doe"
},
"status": "original",
"pipelineId": "original",
"pipelineStage": "original",
"assignees": "original",
"outreachConfigId": "original"
},
"childRecordAssignment": {
"conversations": { "64f0a1b2c3d4e5f6a7b8c9e0": "new" },
"applications": {},
"contactNotes": {},
"reminders": {},
"trainingSnapshots": {}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
fieldSplit: {
firstName: {original: 'Jane', new: 'Janet'},
lastName: {original: 'Doe', new: 'Doe'},
status: 'original',
pipelineId: 'original',
pipelineStage: 'original',
assignees: 'original',
outreachConfigId: 'original'
},
childRecordAssignment: {
conversations: {'64f0a1b2c3d4e5f6a7b8c9e0': 'new'},
applications: {},
contactNotes: {},
reminders: {},
trainingSnapshots: {}
}
})
};
fetch('https://your-instance.example.com/api/contacts/{id}/separate', 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://your-instance.example.com/api/contacts/{id}/separate",
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([
'fieldSplit' => [
'firstName' => [
'original' => 'Jane',
'new' => 'Janet'
],
'lastName' => [
'original' => 'Doe',
'new' => 'Doe'
],
'status' => 'original',
'pipelineId' => 'original',
'pipelineStage' => 'original',
'assignees' => 'original',
'outreachConfigId' => 'original'
],
'childRecordAssignment' => [
'conversations' => [
'64f0a1b2c3d4e5f6a7b8c9e0' => 'new'
],
'applications' => [
],
'contactNotes' => [
],
'reminders' => [
],
'trainingSnapshots' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://your-instance.example.com/api/contacts/{id}/separate"
payload := strings.NewReader("{\n \"fieldSplit\": {\n \"firstName\": {\n \"original\": \"Jane\",\n \"new\": \"Janet\"\n },\n \"lastName\": {\n \"original\": \"Doe\",\n \"new\": \"Doe\"\n },\n \"status\": \"original\",\n \"pipelineId\": \"original\",\n \"pipelineStage\": \"original\",\n \"assignees\": \"original\",\n \"outreachConfigId\": \"original\"\n },\n \"childRecordAssignment\": {\n \"conversations\": {\n \"64f0a1b2c3d4e5f6a7b8c9e0\": \"new\"\n },\n \"applications\": {},\n \"contactNotes\": {},\n \"reminders\": {},\n \"trainingSnapshots\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://your-instance.example.com/api/contacts/{id}/separate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fieldSplit\": {\n \"firstName\": {\n \"original\": \"Jane\",\n \"new\": \"Janet\"\n },\n \"lastName\": {\n \"original\": \"Doe\",\n \"new\": \"Doe\"\n },\n \"status\": \"original\",\n \"pipelineId\": \"original\",\n \"pipelineStage\": \"original\",\n \"assignees\": \"original\",\n \"outreachConfigId\": \"original\"\n },\n \"childRecordAssignment\": {\n \"conversations\": {\n \"64f0a1b2c3d4e5f6a7b8c9e0\": \"new\"\n },\n \"applications\": {},\n \"contactNotes\": {},\n \"reminders\": {},\n \"trainingSnapshots\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/contacts/{id}/separate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fieldSplit\": {\n \"firstName\": {\n \"original\": \"Jane\",\n \"new\": \"Janet\"\n },\n \"lastName\": {\n \"original\": \"Doe\",\n \"new\": \"Doe\"\n },\n \"status\": \"original\",\n \"pipelineId\": \"original\",\n \"pipelineStage\": \"original\",\n \"assignees\": \"original\",\n \"outreachConfigId\": \"original\"\n },\n \"childRecordAssignment\": {\n \"conversations\": {\n \"64f0a1b2c3d4e5f6a7b8c9e0\": \"new\"\n },\n \"applications\": {},\n \"contactNotes\": {},\n \"reminders\": {},\n \"trainingSnapshots\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"originalContactId": "64f0a1b2c3d4e5f6a7b8c9d0",
"newContactId": "64f0a1b2c3d4e5f6a7b8ca20",
"summary": {
"conversationsMoved": 1,
"applicationsMoved": 0,
"notesMoved": 0,
"remindersMoved": 0,
"trainingSnapshotsMoved": 0,
"messagesReassigned": 4
}
}
}{
"error": "Attachment not found",
"message": "Attachment not found"
}{
"error": "Attachment not found",
"message": "Attachment not found"
}{
"error": "Attachment not found",
"message": "Attachment not found"
}{
"error": "Attachment not found",
"message": "Attachment not found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
How each contact field (name, phone, email, documents, misc, etc.) is divided between the original and the newly-created contact.
Show child attributes
Show child attributes
{
"firstName": { "original": "Jane", "new": "Janet" },
"lastName": { "original": "Doe", "new": "Doe" },
"phoneNumber": {
"original": "+14165550100",
"new": "+14165550199"
},
"status": "original",
"pipelineId": "original",
"pipelineStage": "original",
"assignees": "original",
"outreachConfigId": "original"
}
Per-record-type maps assigning each conversation/application/note/reminder/training-snapshot id to either original or new.
Show child attributes
Show child attributes
{
"conversations": { "64f0a1b2c3d4e5f6a7b8c9e0": "original" },
"applications": { "64f0a1b2c3d4e5f6a7b8c9f0": "new" },
"contactNotes": {},
"reminders": {},
"trainingSnapshots": {}
}
Optional per-conversation message-split points indicating where to cut the message timeline between the two contacts.
Show child attributes
Show child attributes
Optional metadata (e.g. channel, assignees) for any brand-new conversations created on the separated contact.
Show child attributes
Show child attributes