Lead Conversions

铅转换API提供了一个简单的数据ce to manage lead conversions. The API allows you to create or read your lead conversions.

JSON format

Retrieve all lead conversions

             

              
GET/v2/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 bypageorcursorparam. The usage of thepageparam is limited up to number50. In order to fetch further records you should usecursorparam. A link with specified cursor is provided in the response undermetasection asnext_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_idordeal_id.

Parameters

Allowed for

• Agents

Using cURL

             

              
旋度-v -X GET https://api.getbase.com/v2/lead_conversions\-H"Accept: application/json"\-H"Authorization: Bearer$ACCESS_TOKEN"
             

Example response

             

              
HTTP/1.1200OKContent-Type:application/json; charset=utf-8Content-Language:en{"items":[{"data":{"id":2,"lead_id":2,"individual_id":4,"organization_id":5,"deal_id":5,"creator_id":1,"created_at":"2021-02-17T16:32:56Z"},"meta":{"type":"lead_conversion","links":{"individual":"https://api.getbase.com/v2/contacts/4","organization":"https://api.getbase.com/v2/contacts/5","deal":"https://api.getbase.com/v2/deals/5"}}},{"data":{"id":1,"lead_id":1,"individual_id":3,"organization_id":null,"deal_id":null,"creator_id":2,"created_at":"2021-02-17T16:32:57Z"},"meta":{"type":"lead_conversion","links":{"individual":"https://api.getbase.com/v2/contacts/3","organization":null,"deal":null}}}],"meta":{"type":"collection","count":2,"links":{"next_page":"https://api.getbase.com/v2/lead_conversions?cursor=eyJsYXN0X2lkIjo2NTA3ODF9%0A&per_page=25"}}}
             

---

Create a lead conversion

             

              
POST/v2/lead_conversions
             

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 specifiedlast_name, an individual is created as a result of the conversion.
2. If a lead has specifiedorganization_name, an organization is created as a result of the conversion.
3. If bothlast_nameandorganization_namefields are specified, lead will be converted to an individual and an organization.

Parameters

Allowed for

• Agents

Using cURL

             

              
旋度-v -X POST https://api.getbase.com/v2/lead_conversions\-H"Accept: application/json"\-H"Content-Type: application/json"\-H"Authorization: Bearer$ACCESS_TOKEN"\-d'{"data": {"lead_id": 2,"owner_id": 7,"create_deal": false}}'
             

Example response

             

              
Content-Type:application/json; charset=utf-8Content-Language:en{"data":{"id":1,"lead_id":2,"individual_id":3,"organization_id":4,"deal_id":null,"creator_id":1,"created_at":"2021-02-17T16:32:56Z"},"meta":{"type":"lead_conversion","links":{"individual":"https://api.getbase.com/v2/contacts/3","organization":"https://api.getbase.com/v2/contacts/4","deal":null}}}