Merge Leads

POST /rest/v1/leads/{leadId}/merge.json

Merges two or more known lead records into a single lead record.

Operation ID: mergeLeadsUsingPOST
Permissions: Read-Write Lead
Request format: application/json
Returns: ResponseWithoutResult

Parameters

Path 1

leadId integer (int64) required

The id of the winning lead record

Query 3

leadId integer (int64)

The id of the losing record

leadIds array of integer

A comma-separated list of ids of losing records

mergeInCRM boolean

If set, will attempt to merge the designated records in a natively-synched CRM. Only valid for instances with are natively synched to SFDC.

Responses

200 OK ResponseWithoutResult

errors array of Error

Array of errors that occurred if the request was unsuccessful

Model Error

code string required

Error code of the error. See full list of error codes here

message string required

Message describing the cause of the error

nextPageToken string

Paging token returned from a previous response

requestId string required

Id of the request made

success boolean required

Whether the request succeeded

warnings array of Warning

Array of warnings given for the operation

Model Warning

code integer (int32) required

Integer code of the warning

message string required

Message describing the warning

Generated example

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "nextPageToken": "example-token",
  "requestId": "123",
  "success": false,
  "warnings": [
    {
      "code": 123,
      "message": "string"
    }
  ]
}

Referenced models

Generated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.