Leads

Merge a duplicate lead

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.

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)

Headers

Idempotency-Keystring

Optional client-generated key (1 to 255 characters, e.g. a UUID v4) that makes the request idempotent for 24 hours: a retry with the same key replays the recorded response (marked Idempotency-Replayed: true) instead of executing the operation again. Same key with another body: 422 idempotency_key_reuse; while the first request runs: 409 idempotency_conflict. See the Idempotency section.

Request body

into_lead_idstring uuid required

The lead that keeps the request.

Response

Merged.

successboolean required
outcome'merged' | 'linked_to_event' required
survivor_lead_idstring uuid required
event_idstring uuid

Only with linked_to_event.

invertedboolean

Only with linked_to_event.

Changes

No recorded changes to this operation across all 1 revision of this API.