Pipeliner CRM Cloud API

Create a contact

This tutorial explains how you can create a Contact, an entity type, in the Pipeliner CRM. This entity refers to the person you are communicating with regarding a Lead or an Opportunity. To know more about the Contact entity, refer to the article – Understanding Accounts and Contacts.

You can create a new lead using the Contacts.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 contact. However, first_name, last_name, and owner_id are mandatory parameters. Click here to know more about the other parameters you can add as the payload to the HTTP request for creating a contact.

Parameter name Value Description
first_name string Required. Simple text input field.
last_name string Required. Simple text input field.
owner_id string Required. Relation to single entity instance.

Note: Using the POSTMAN tool you can run the Contacts.list endpoint request to fetch the owner_id for the corresponding space_id in which you want to create the new contact.

Example:

List Contacts

Endpoint name: Contacts.create

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

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 contact, 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 Contacts.create API. The below screenshot explains the steps to send the request with the required parameters in the JSON format.

Create Contact

Next Steps

After creating the contact, you may want to associate it with a lead and the account. To link an account and lead to the newly created contact:

  • Use the account list to fetch the account that you want to link with the contact.
    If you do not have the account name in the account list, then create an account.