Lead Conversions

The Lead Conversions API provides a simple interface to manage lead conversions. The API allows you to create or read your lead conversions.

Properties

Attribute Description
id number readonly

Unique identifier of the lead conversion.

lead_id number readonly

Unique identifier of the converted lead.

individual_id number readonly

Unique identifier of the individual created as a result of the conversion.

organization_id number readonly

Unique identifier of the organization created as a result of the conversion.

deal_id number readonly

Unique identifier of the deal created as a result of the conversion.

created_at string readonly

Date and time of the creation in UTC (ISO8601 format).


Endpoints


Retrieve all lead conversions

Returns all lead conversions available to the user according to the provided parameters. Records are sorted in descending order by lead conversion ID. They can be paginated by page or cursor param. The usage of the page param is limited up to number 50. In order to fetch further records you should use cursor param. A link with specified cursor is provided in the response under meta section as next_page. The link is always present if only there are subsequent records available.

It is possible to retrieve specific conversion by ID of the converted lead or by IDs of the created objects by providing one of the parameters: lead_id, individual_id, organization_id or deal_id.

Parameters

Attribute Description
page number optional

Page number to start from. Page numbering starts at 1 and omitting the page parameter will result in returning the first page. The maximum requested page can be 50.

e.g. ?page=2
per_page number optional

Number of records to return on one page. The default limit is 25 and the maximum size of page is 200.

e.g. ?per_page=20
cursor string optional

Pagination token for an iteration over the records. It allows for fetching a set of subsequent data.

e.g. ?cursor=eyJsYXN0X2lkIjo2NTA3ODF9%250A
lead_id number optional

Unique identifier of the lead that has been converted.

e.g. ?lead_id=2
individual_id number optional

Unique identifier of the contact (individual) created as a result of the conversion.

e.g. ?individual_id=3
organization_id number optional

Unique identifier of the contact (organization) created as a result of the conversion.

e.g. ?organization_id=4
deal_id number optional

Unique identifier of the deal created as a result of the conversion.

e.g. ?deal_id=5

Create a lead conversion

Converts a lead to an individual and/or an organization and/or a deal and returns created lead conversion record. After successful conversion all activities associated with the converted lead are attached to newly created contacts and/or deal asynchronously with minimal delay.

The lead conversion is about converting a lead into a contact and - optionally - creating a deal for the created contacts. Lead can be converted to an individual or an organization or both. Possible scenarios:

  1. If a lead has specified last_name, an individual is created as a result of the conversion.

  2. If a lead has specified organization_name, an organization is created as a result of the conversion.

  3. If both last_name and organization_name fields are specified, lead will be converted to an individual and an organization.

Parameters

Attribute Description
lead_id number required

Unique identifier of the lead that is going to be converted.

e.g. "lead_id": "1"
owner_id number optional

Unique identifier of the user that will be set as an owner of all objects created during conversion. If not provided, all these objects will be owned by the current lead’s owner.

e.g. "owner_id": "2"
create_deal boolean optional

Indicates whether a deal should be created as a result of the conversion. Default is true.

e.g. "create_deal": "true"