<!-- Generated by scripts/generate_endpoint_docs.py — do not edit by hand. -->
# `api.contacts.merge_preview`

> `POST /contacts/{mergeToId}/merge/preview` — ACPortal

**Python**

```python
api.contacts.merge_preview(merge_to_id: str, *, data: ContactMergeRequest | dict) -> ContactMergePreview
```

**CLI**

```bash
ab contacts merge_preview <merge_to_id> [--data ...]
```

POST /contacts/{mergeToId}/merge/preview.

Args:
    merge_to_id: Target contact to merge into.
    data: Merge preview request payload.
        Accepts a :class:`ContactMergeRequest` instance or a dict.

Request model: :class:`ContactMergeRequest`

## Request body — `ContactMergeRequest`

| Field | Type | Required | Description |
|---|---|---|---|
| `mergeFromId` | `Optional[str]` | no | Source contact ID to merge from |

## Response

Returns `ContactMergePreview`.

| Field | Type | Required | Description |
|---|---|---|---|
| `mergeTo` | `Optional[dict]` | no | Target contact |
| `mergeFrom` | `Optional[dict]` | no | Source contact |
| `conflicts` | `Optional[list[dict]]` | no | Merge conflicts |

---

[← Back to api.contacts](../contacts.md)