Skip to main content
POST
Merge two contacts

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Query Parameters

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

Body

application/json
kept_id
string
required

The contact that will be kept after the merge.

merge_id
string
required

The contact whose data will be merged into kept_id (deleted after merge).

dry_run
boolean
default:true

When true (default), returns a preview without modifying data. Pass false to execute the merge.

Response

The merge result. message is "Merge preview generated" for a dry run and "Contacts merged successfully" when actually merged.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
object

Outcome of a contact merge. Defaults to a DRY RUN — pass dry_run: false to apply it. Full contact records are replaced with public info before returning.