Skip to main content
POST
Merge duplicate contacts

Authorizations

Authorization
string
header
required

Session JWT (from register/login) or API key (pk_...). X-API-Key: <token> is accepted as an alternative header.

Body

application/json
contact_ids
string<uuid>[]
required

Distinct contacts of your account book to fuse.

Required array length: 2 - 20 elements
surviving_contact_id
string<uuid>

The contact that survives (must be one of contact_ids; defaults to the first).

display_name
string

Optional override for the surviving display name.

alias
string

Optional override for the surviving alias.

Response

Merged contact with all destinations.

contact_id
string<uuid>
display_name
string
alias
string
phone
string

E.164.

email
string
has_cbpay
boolean

True when the phone matches an active account of your operator.

cbpay_account_id
string<uuid>

Linked account (present when has_cbpay is true).

source
enum<string>
Available options:
manual,
import,
transfer,
payout,
crypto
favorite
boolean
destinations
object[]

Present on the detail endpoint and on contact lists when expand=destinations. Optional dest_type and dest_country filters apply only to this expanded field.

created_at
string<date-time>
updated_at
string<date-time>
merged_contact_ids
string<uuid>[]

Source contacts that were deleted by the merge.