Skip to main content
POST
Separate one contact into two

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
fieldSplit
object
required

How each contact field (name, phone, email, documents, misc, etc.) is divided between the original and the newly-created contact.

Example:
childRecordAssignment
object
required

Per-record-type maps assigning each conversation/application/note/reminder/training-snapshot id to either original or new.

Example:
messageDividers
object[]

Optional per-conversation message-split points indicating where to cut the message timeline between the two contacts.

newConversationMeta
object[]

Optional metadata (e.g. channel, assignees) for any brand-new conversations created on the separated contact.

Response

Contact separated

success
enum<boolean>
required
Available options:
true
data
object
required