Contacts

Separate one contact into two

POST
/api/contacts/{id}/separate

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.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/contacts/string/separate" \  -H "Content-Type: application/json" \  -d '{    "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": {}    }  }'
{  "success": true,  "data": {    "originalContactId": "64f0a1b2c3d4e5f6a7b8c9d0",    "newContactId": "64f0a1b2c3d4e5f6a7b8ca20",    "summary": {      "conversationsMoved": 1,      "applicationsMoved": 0,      "notesMoved": 0,      "remindersMoved": 0,      "messagesReassigned": 4    }  }}