---
title: "Merge a duplicate lead"
method: POST
path: "/leads/{id}/merge"
tags: ["Leads"]
---

# Merge a duplicate lead

`POST /leads/{id}/merge`

## Request

- Base URL: `https://joinways.app/api/v1`
- URL: `https://joinways.app/api/v1/leads/{id}/merge`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://joinways.app/oauth/authorize`, token URL `https://joinways.app/api/oauth/token`, scopes: `mcp.write`)

Folds the lead of the path (the duplicate) into `into_lead_id` (the lead that keeps the request), like « Merge » in the Inbox. Outcomes: `merged` (the duplicate is archived, pointing at the survivor) or `linked_to_event` (one of them is converted: the other joins its event; `inverted: true` when the path lead was the converted one). Nothing is deleted. Fires `lead.merged`. **Role permission:** `leads.manage`.

## Headers

- `Idempotency-Key` string

## Request body

- object
  - `into_lead_id` string, uuid, required: The lead that keeps the request.

## Response `200`

Merged.

- object
  - `success` boolean, required
  - `outcome` 'merged' | 'linked_to_event', required
  - `survivor_lead_id` string, uuid, required
  - `event_id` string, uuid: Only with `linked_to_event`.
  - `inverted` boolean: Only with `linked_to_event`.

## Other responses

- `400`: Validation failed (`invalid_request`). For a body that fails the schema, `details` holds `formErrors` and `fieldErrors`.
- `401`: Missing, invalid, expired or revoked bearer token (`unauthorized`).
- `403`: `forbidden`: the token lacks the scope, its owner's role lacks the permission named by the operation, or the workspace has neither the Pro plan nor a trial (`details.reason` `plan_not_eligible`).
- `404`: Not found in this workspace, or the id of the path is not a UUID (`not_found`).
- `409`: The state of the record refuses the operation (`conflict`). `details.reason` is a stable code.
- `429`: Too many requests (`rate_limited`). `details.reason`: `per-ip`, `per-account-minute`, `per-account-day`, or `email_rate_limited` (email budget). Always carries `Retry-After`: wait that many seconds.

---

[API](https://skmtc.dev/joinways/apis/joinways-public-api.md) · [All operations](https://skmtc.dev/joinways/apis/joinways-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/joinways/apis/joinways-public-api/revisions/39e84309953e?raw)
