Pipeliner CRM Cloud API

Create a new lead

This tutorial explains how you can create a Lead, an entity type, in the Pipeliner CRM. This entity refers to a cold, unqualified enquiry not yet qualified to be a part of your actual Pipeline or Sales Funnel. To know more about the Lead entity, refer to the article – Understanding Pipelines, Leads, Opportunities and Activities.

You can create a new lead using the Leads.create endpoint. However, before you can use this endpoint, you must have the following details.

  • Service URL
  • Space ID

To learn more about how to obtain the Service URL and Space ID details, see the tutorial.

Parameters

There are various parameters that you can pass as the payload to create a new lead. However, name, and unit_id are mandatory parameters. Click here to know more about the other parameters that you can add as the payload to the HTTP request for creating a lead.

Parameter name Value Description
name string Required. Name of the entity and its default text representation.
unit_id string Required. Relation to a single entity instance.

Note: Using the POSTMAN tool you can run the SalesUnits.list endpoint request to fetch the unit_id for the corresponding space_id in which you want to create the new lead.

Example:
Get UnitID

Endpoint name: Leads.create

This endpoint uses the POST method to create a new lead.

Request URL Syntax

Copy to Clipboard

Example Request URL
Copy to Clipboard

Note: For identifying your space_id, refer to the tutorial About API.

Example Request Body

The request body is passed as raw JSON data format.

Copy to Clipboard
Example Response
Copy to Clipboard
Status Code

Success: true

After passing the POST request to create a new lead, if you get the “success”: true message, then it means your record is created successfully.

How to create a new lead using Postman

You can use Postman or any other API tool for creating a new lead using Leads.create API. The below screenshot explains the steps to send the request with the required parameters in the JSON format.

Create leads

Note: You can search for Leads that you have created based on a specified search criteria. Refer to Search a record for details.

Next Steps

After creating the lead, you may link the lead with a contact. To add a contact to the newly created lead:

  • Use the contact list to fetch the contact name and link with the lead. If you do not have the contact name in the contact list, then you may create a contact.