Pipeliner CRM Cloud API

You can link records, such as Leads, Contacts, Accounts, and Opportunities using Pipeliner CRM APIs. For example, you can link an Opportunity with an Account and a Contact.

This tutorial explains how to perform the following tasks:

  • Linking a Lead and Opportunity with an Account
  • Linking a Lead and Opportunity with a Contact
  • Linking a Contact with an Account

Linking a Lead and Opportunity with an Account

The following section of this tutorial explains how you can link a Lead and Opportunity (LeadOppty) with an Account. To link a Lead and Opportunity with an Account, you need to use the LeadOpptyAccountRelations.create endpoint.

The following table describes the parameters you must provide as payload to link a Lead and Opportunity with an Account using the LeadOpptyAccountRelations.create endpoint.

Parameter name Value Description
account_id string Required. Account ID with which you want to link the Lead and Opportunity.
is_primary string Required. Specify if this is a primary Account for the Lead and Opportunity.
lead_oppty_id string Required. Lead and Opportunity ID with which you want to link the specified Account.

To get the Account ID and LeadOppty ID that you want to link, do the following steps.

  1. Fetch all the Account details to identify the appropriate Account ID using the Accounts.list endpoint.
  2. Fetch all the LeadOpportunities to identify the appropriate LeadOpportunity ID using the LeadOppties.list endpoint.

Note: For information on using a .list endpoint, see the section “Perform a basic search to fetch records” in the Search a record tutorial.

Endpoint name: LeadOpptyAccountRelations.create

This endpoint uses the POST method to link an Account with a LeadOppty.

Request URL Syntax

Copy to Clipboard

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

Example Request URL

Copy to Clipboard

Example Request Body

Copy to Clipboard

Example Response

Copy to Clipboard

Status code

Success: true

After passing the POST request to link an Account with a LeadOppty, if you get the “success”: true message, then it means that the linking is successful.

Linking a Lead and Opportunity with a Contact

The following section of this tutorial explains how you can link a Lead and Opportunity with a Contact. To link a Lead and Opportunity (LeadOppty) with a Contact, you need to use the LeadOpptyAccountRelations.create endpoint.

The following table describes the parameters you must provide as payload to link a Lead and Opportunity with an Contact using the LeadOpptyAccountRelations.create endpoint.

Parameter name Value Description
contact_id string Required. Contact ID with which you want to link the Lead and Opportunity.
is_primary string Required. Specify if this is a primary Contact for the Lead and Opportunity.
lead_oppty_id string Required. Lead and Opportunity ID with which you want to link the specified Contact.

To get the Contact ID and LeadOppty ID that you want to link, do the following steps.

  1. Fetch all the Contact details to identify the appropriate Contact ID using the Contacts.list endpoint.
  2. Fetch all the LeadOpportunities to identify the appropriate LeadOpportunity ID using the LeadOppties.list endpoint.

Note: For information on using a .list endpoint, see the section “Perform a basic search to fetch records” in the Search a record tutorial.

Endpoint name: LeadOpptyAccountRelations.create

This endpoint uses the POST method to link a Contact with a LeadOppty.

Request URL Syntax

Copy to Clipboard

Example Request URL

Copy to Clipboard

Example Request Body

Copy to Clipboard

Example Response

Copy to Clipboard

Status code

Success:true

After passing the POST request to link a Contact with a LeadOppty, if you get the “success”: true message, then it means that the linking is successful.

Linking a Contact with an Account

The following section of this tutorial explains how you can link a Contact with an Account. To link a Contact with an Account, you need to use the ContactAccountRelations endpoint.

The following table describes the parameters you must provide as payload to link a Lead and Opportunity with an Contact using the LeadOpptyAccountRelations.create endpoint.

Parameter name Value Description
account_id string Required. Account ID with which you want to link the specified Contact.
contact_id string Required. Contact ID with which you want to link the Account.
is_primary string Required. Specify if this is a primary Contact for the Account.

To get the Contact ID and Account ID that you want to link, do the following steps.

  1. Fetch all the Contact details to identify the appropriate Contact ID using the Contacts.list endpoint.
  2. Fetch all the Account details to identify the appropriate Account ID using the Accounts.list endpoint.

Note: For information on using a <name>.list endpoint, see the section “Perform a basic search to fetch records” in the Search a record tutorial.

Endpoint name: ContactAccountRelations.create

This endpoint uses the POST method to link a Contact with an Account.

Request URL Syntax

Copy to Clipboard

Example Request URL

Copy to Clipboard

Example Request Body

Copy to Clipboard

Example Response

Copy to Clipboard

Status code

Success:true

After passing the POST request to link a Contact with an Account, if you get the “success”: true message, then it means that the linking is successful.