Create Opportunity

This tutorial should help you create the first Opportunity. Before moving forward, make sure your Authentication works and you understand the Key Concepts of the Pipeliner API and make sure you know how to use API parameters

The Opportunity represents existing potential business for a company. Go to the web Application and Opportunities can be located on the Opportunities screen. Opportunity is always part of the Pipeline and pipeline step.

The Pipeline is the list of steps (eg. First Contact, Proposal, Closed/Won), that represents the life cycle of the opportunity. Set up your first Pipeline

Tutorial Assignment

Create Opportunity in the Pipeline within the First Step of the Pipeline. This Opportunity will be Linked with an Account(Company) and multiple Contact that belongs to this Account.

0. Required fields

Required API field Name	Description
name	Name of the opportunity
owner_id	Id of the User in Pipeliner Application
closing_date	Expected Closing date. When the opportunity should be closed
step_id	ID of the Pipeline step where the Opportunity should be created
value	The business value of Opportunity, eg. dollar amount. base_value - The Real Business Value in dollars currency_id - The ID of currency saved in Pipeliner value_foreign - The value for currency_id (Use only with multicurrency setup)

1. Prepare Data

Owner_id

Load an id of the user with the default sales unit. This user will become the owner of the newly created Opportunity.

Returns all defined Clients

GEThttps://us-east.pipelinersales.com/api/v100/rest/spaces/<space_id>/entities/Clients

Query parameters

Response

200500

list of Clients

Body

application/json

successboolean

True when response succeeded, false on error.

dataarray of Client (object)

page_infoobject

Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.

Request

JavaScriptCurl

const response = await fetch('https://us-east.pipelinersales.com/api/v100/rest/spaces/<space_id>/entities/Clients', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": true,
  "data": [
    {
      "is_delete_protected": false,
      "id": "01234567-abcd-dcba-ffff-000000000000",
      "is_deleted": false,
      "modified": "2019-01-01T00:00:00",
      "created": "2019-01-01T00:00:00",
      "default_unit": "https://example.com",
      "master_right": "https://example.com",
      "default_unit_id": "01234567-abcd-dcba-ffff-000000000000",
      "email": "string",
      "first_name": "string",
      "last_active": "2019-01-01T00:00:00",
      "last_name": "string",
      "master_right_id": "01234567-abcd-dcba-ffff-000000000000",
      "middle_name": "string",
      "phone": "string",
      "picture_url": "string",
      "position": "string",
      "region": "string",
      "timezone": "string",
      "revision": 1,
      "default_idp": 1,
      "unit_membership": [
        "https://example.com"
      ],
      "appointment_favorite": [
        "https://example.com"
      ],
      "task_favorite": [
        "https://example.com"
      ],
      "account_favorite": [
        "https://example.com"
      ],
      "contact_favorite": [
        "https://example.com"
      ],
      "profile_favorite": [
        "https://example.com"
      ],
      "report_favorite": [
        "https://example.com"
      ],
      "lead_favorite": [
        "https://example.com"
      ],
      "opportunity_favorite": [
        "https://example.com"
      ],
      "name": "string",
      "formatted_name": "string",
      "unit_manager_ids": [
        "01234567-abcd-dcba-ffff-000000000000"
      ],
      "unit_member_ids": [
        "01234567-abcd-dcba-ffff-000000000000"
      ]
    }
  ],
  "page_info": {
    "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
    "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
    "has_previous_page": true,
    "has_next_page": true
  }
}

{{baseUrl}}/entities/Clients?load-only=id,default_unit_id&filter[email]=[e-mail]

{
            "id": "00000000-0000-0000-0000-000000011a7d",
            "default_unit_id": "aba4a358-f3f8-4f55-b3ed-dd5cf589103b"
}

We don´t necessarily need to load the default unit id. If only owner_id is specified in the final request, Pipeliner will automatically create the opportunity with the default User´s sales unit. (See step 2. of this tutorial)

Step_id

Pull Opportunity Pipelines and their steps. Store the ID of the First Step

Returns all defined Pipelines

GEThttps://us-east.pipelinersales.com/api/v100/rest/spaces/<space_id>/entities/Pipelines

Query parameters

Response

200500

list of Pipelines

Body

application/json

successboolean

True when response succeeded, false on error.

dataarray of Pipeline (object)

page_infoobject

Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.

Request

JavaScriptCurl

const response = await fetch('https://us-east.pipelinersales.com/api/v100/rest/spaces/<space_id>/entities/Pipelines', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": true,
  "data": [
    {
      "is_delete_protected": false,
      "id": "01234567-abcd-dcba-ffff-000000000000",
      "is_deleted": false,
      "modified": "2019-01-01T00:00:00",
      "created": "2019-01-01T00:00:00",
      "color": 1,
      "name": "string",
      "revision": 1,
      "steps": [
        {
          "name": "string",
          "percent": 1,
          "timeframe": 1,
          "revision": 1,
          "documents": [
            {
              "id": "https://example.com"
            }
          ],
          "step_checklists": [
            {
              "id": "https://example.com"
            }
          ],
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "opportunity_types": [
        "https://example.com"
      ]
    }
  ],
  "page_info": {
    "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
    "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
    "has_previous_page": true,
    "has_next_page": true
  }
}

{{baseUrl}}/entities/Pipelines?expand=steps&filter-op[name]=contains&filter[name]=Test Pipeline

 {
            "is_delete_protected": false,
            "id": "90be8a83-bae8-401d-9e5e-c4564a986270",
            "is_deleted": false,
            "modified": "2020-09-25 10:48:29.825069+00:00",
            "created": "2020-08-12 15:00:21.732550+00:00",
            "color": 16233984,
            "name": "Test Pipeline",
            "revision": 66001,
            "steps": [
                {
                    "is_delete_protected": false,
                    "id": "de115511-5dc1-46c3-86d9-f714457208dd",
                    "is_deleted": false,
                    "modified": "2020-08-12 15:00:21.734413+00:00",
                    "created": "2020-08-12 15:00:21.734454+00:00",
                    "pipeline": "https://us-east.pipelinersales.com/api/v100/rest/spaces/nv3_PipelinerDev/entities/Pipelines/90be8a83-bae8-401d-9e5e-c4564a986270",
                    "name": "First",
                    "percent": 15,
                    "pipeline_id": "90be8a83-bae8-401d-9e5e-c4564a986270",
                    "sort_order": 0,
                    "timeframe": null,
                    "revision": 65654,
                    "documents": [],
                    "step_checklists": []
                }
                
}

Account_id

We are going to search for Accounts by email address. But you can use whatever parameter.

{{baseUrl}}/entities/Accounts?include-deleted=false&filter[email1]=[e-mail]

{
            "is_delete_protected": false,
            "id": "0bc376a4-c579-413a-9221-e86e4a134766",
            "is_deleted": false,
            "modified": "2019-02-01 10:01:23.011709+00:00",
            "created": "2019-01-30 11:44:23.586083+00:00",
            "account_type": "https://us-east.pipelinersales.com/api/v100/rest/spaces/nv3_PipelinerDev/entities/AccountTypes/a456236f-6f23-0908-abfd-384aa0f62f9e",
            "customer_type": "https://us-east.pipelinersales.com/api/v100/rest/spaces/nv3_PipelinerDev/entities/Data/04444b3a-c669-03bc-2c49-bcd7f047d41a",
            "industry": "https://us-east.pipelinersales.com/api/v100/rest/spaces/nv3_PipelinerDev/entities/Data/acbda72f-2054-0b71-9d42-cb35aaa37600",
            "owner": "https://us-east.pipelinersales.com/api/v100/rest/spaces/nv3_PipelinerDev/entities/Clients/00000000-0000-0000-0000-000000011a3d",
            "parent_account": null,
            "parent_account_relation_type": null,
            "picture": "https://us-east.pipelinersales.com/api/v100/rest/spaces/nv3_PipelinerDev/entities/CloudObjects/5ddfe953-a569-48e1-86bb-271e6506e7d0",
            "unit": "https://us-east.pipelinersales.com/api/v100/rest/spaces/nv3_PipelinerDev/entities/SalesUnits/ea33e8fb-9a56-4802-a175-2d1f406af7cf",
            "account_class": 5,
            "account_type_id": "a456236f-6f23-0908-abfd-384aa0f62f9e",
            "address": "7 Lillian Plaza",
            "city": "Coronda",
            "comments": "",
            "country": "Argentina",
            "customer_type_id": "04444b3a-c669-03bc-2c49-bcd7f047d41a",
            "email1": "[e-mail]",
            "email2": "",
            "email3": "",
            "email4": "",
            "email5": "",
            "health_category": null,
            "health_status": null,
            "home_page": "www.ziemannandsons.com",
            "industry_id": "acbda72f-2054-0b71-9d42-cb35aaa37600",
            "name": "Ziemann and Sons",
            "owner_id": "00000000-0000-0000-0000-000000011a3d",
            "parent_account_id": null,
            "parent_account_relation_type_id": null,
            "phone1": "[phone]",
            "..."
        }

Contact_id

We are going to search for Contacts that are linked to the Account. We are going to use Account_id from the previous Step and list all contact_id that exists on the Account

Returns all defined ContactAccountRelations

GEThttps://us-east.pipelinersales.com/api/v100/rest/spaces/<space_id>/entities/ContactAccountRelations

Query parameters

Response

200500

list of ContactAccountRelations

Body

application/json

successboolean

True when response succeeded, false on error.

dataarray of ContactAccountRelation (object)

page_infoobject

Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.

Request

JavaScriptCurl

const response = await fetch('https://us-east.pipelinersales.com/api/v100/rest/spaces/<space_id>/entities/ContactAccountRelations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": true,
  "data": [
    {
      "is_delete_protected": false,
      "id": "01234567-abcd-dcba-ffff-000000000000",
      "is_deleted": false,
      "modified": "2019-01-01T00:00:00",
      "created": "2019-01-01T00:00:00",
      "account": "https://example.com",
      "contact": "https://example.com",
      "account_id": "01234567-abcd-dcba-ffff-000000000000",
      "comment": "string",
      "contact_id": "01234567-abcd-dcba-ffff-000000000000",
      "is_assistant": false,
      "is_primary": false,
      "is_sibling": false,
      "position": "string",
      "relationship": 0,
      "revision": 1,
      "account_roles": [
        "https://example.com"
      ]
    }
  ],
  "page_info": {
    "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
    "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
    "has_previous_page": true,
    "has_next_page": true
  }
}

{{baseUrl}}/entities/ContactAccountRelations?filter[account_id]=0bc376a4-c579-413a-9221-e86e4a134766

{
            "is_delete_protected": false,
            "id": "7bb50668-badb-4c4b-a184-2f2be3df4fd8",
            "is_deleted": false,
            "modified": "2019-01-30 11:54:15.289916+00:00",
            "created": "2019-01-30 11:54:15.289965+00:00",
            "account": "https://us-east.pipelinersales.com/api/v100/rest/spaces/nv3_PipelinerDev/entities/Accounts/0bc376a4-c579-413a-9221-e86e4a134766",
            "contact": "https://us-east.pipelinersales.com/api/v100/rest/spaces/nv3_PipelinerDev/entities/Contacts/02bdc9f6-4dfb-479e-84ba-f6c3b96c39ba",
            "account_id": "0bc376a4-c579-413a-9221-e86e4a134766",
            "comment": "",
            "contact_id": "02bdc9f6-4dfb-479e-84ba-f6c3b96c39ba",
            "is_assistant": false,
            "is_primary": true,
            "is_sibling": false,
            "position": "",
            "relationship": 0,
            "revision": 184,
            "account_roles": []
        }

Value

1. Foreign value (required/optional) - This is the value that the User (SalesPerson) can put into the system. This value is depending on currency_id.

   1. Example: if your salespeople want to have an Opportunity Value in Euro, for currency_id use Euro, into the Foreign value put the amount in Euro

2. currency_id (Required) - the currency for the opportunity (like dollar, euro, etc.). In Pipeliner there are two types of currencies

   1. Base currency - System currency (the main currency)

   2. Multiple currencies (custom currencies) - When your business works with multiple currencies

3. base_value (required/optional) - this value is always calculated according to the Base Currency

You can use one of the foreign values, base_value. It depends on what fits you better.

When you define base value, then Foreign Currency is calculated automatically based on Exchange rates

When you define Foreign Currency, then the base value is calculated automatically based on Exchange rates

Value.currency_id

In this tutorial, we don´t use a multi-currency setup, so we are going to search for the base currency (system currency). To retrieve base currency let´s use the following request. Base currency is flagged as is_base:true

Returns all defined Currencies

GEThttps://us-east.pipelinersales.com/api/v100/rest/spaces/<space_id>/entities/Currencies

Query parameters

Response

200500

list of Currencies

Body

application/json

successboolean

True when response succeeded, false on error.

dataarray of Currency (object)

page_infoobject

Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.

Request

JavaScriptCurl

const response = await fetch('https://us-east.pipelinersales.com/api/v100/rest/spaces/<space_id>/entities/Currencies', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": true,
  "data": [
    {
      "is_delete_protected": false,
      "id": "01234567-abcd-dcba-ffff-000000000000",
      "is_deleted": false,
      "modified": "2019-01-01T00:00:00",
      "created": "2019-01-01T00:00:00",
      "code": "string",
      "is_base": false,
      "symbol": "string",
      "revision": 1,
      "currency_exchange_rates": [
        "https://example.com"
      ]
    }
  ],
  "page_info": {
    "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
    "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
    "has_previous_page": true,
    "has_next_page": true
  }
}

{{baseUrl}}/entities/Currencies?filter[is_base]=true

{
            "is_delete_protected": true,
            "id": "c4ca4238-a0b9-0382-0dcc-509a6f75849b",
            "is_deleted": false,
            "modified": "2019-01-30 11:20:40.481012+00:00",
            "created": "2019-01-11 13:47:33.247720+00:00",
            "code": "USD",
            "is_base": true,
            "symbol": "$",
            "revision": 18,
            "currency_exchange_rates": []
}

2. Create Opportunity

Let´s Take data from Step 1. and use them in the following request to create an Opportunity.

Creates new opportunity

POSThttps://us-east.pipelinersales.com/api/v100/rest/spaces/<space_id>/entities/Opportunities

Query parameters

Body

application / json

data of new Opportunity

modifiedstring (date-time)

Last modification time.

createdstring (date-time)

Creation time.

closing_date*string (date)

Closing date of the Opportunity.

descriptionstring

Multi-line text input field.

is_archivedboolean

Boolean value.

is_value_auto_calculateboolean

Boolean value.

label_flagenum

Opportunity label flag.

Options: Priority = 1 (0b001) Hot = 2 (0b010) Stalled = 4 (0b100)

124

name*string

Name of the entity and its default text representation.

oppty_type_idstring (uuid)

Relation to single entity instance.

owner_id*string (uuid)

Relation to single entity instance.

product_currency_idstring (uuid)

Relation to single entity instance.

product_price_list_idstring (uuid)

Relation to single entity instance.

product_sectionsobject

Product sections on Opportunity in json format

quick_account_emailstring

Simple text input field.

quick_account_namestring

Simple text input field.

quick_account_phonestring

Simple text input field.

quick_contact_namestring

Simple text input field.

quick_emailstring

Simple text input field.

quick_phonestring

Simple text input field.

rankinginteger (int32)

Qualitative ranking of the opportunity.

reason_of_close_descriptionstring

Multi-line text input field.

reason_of_close_idstring (uuid)

Relation to single entity instance.

share_modeenum

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

0123

step_id*string (uuid)

Relation to single entity instance.

unit_idstring (uuid)

Relation to single entity instance.

was_qualifiedboolean

Boolean value.

revisioninteger (int32)

Revision when entity was lastly changed.

value*object

Monetary value in a foreign currency.

oppty_recurrenceobject

Relation to OpptyRecurrence, see: 'createOpptyRecurrenceInput' object for properties.

revenue_scheduleobject

Relation to OpptyRevenueSchedule, see: 'createOpptyRevenueScheduleInput' object for properties.

product_relationsarray of object

Relations to Products.

contact_relationsarray of object

Relations to Contacts.

account_relationsarray of object

Relations to Accounts.

documentsarray of object

Relations to CloudObjects.

won_datestring (date-time)

lost_datestring (date-time)

sharing_unitsarray of object

Relations to SalesUnits.

sharing_clientsarray of object

Relations to Clients.

Response

201500

Creation confirmation. Returns created opportunity

Body

application/json

successboolean

True when response succeeded, false on error.

dataOpportunity (object)

Request

JavaScriptCurl

const response = await fetch('https://us-east.pipelinersales.com/api/v100/rest/spaces/<space_id>/entities/Opportunities', {
    method: 'POST',
    headers: {
      "Content-Type": "application / json"
    },
    body: JSON.stringify({
      "closing_date": "2019-01-01",
      "name": "string",
      "owner_id": "01234567-abcd-dcba-ffff-000000000000",
      "step_id": "01234567-abcd-dcba-ffff-000000000000",
      "value": {
        "base_value": "4.32",
        "currency_id": "01234567-abcd-dcba-ffff-000000000000",
        "value_foreign": "4.32"
      }
    }),
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "is_delete_protected": false,
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "is_deleted": false,
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "oppty_type": "https://example.com",
    "owner": "https://example.com",
    "product_currency": "https://example.com",
    "product_price_list": "https://example.com",
    "reason_of_close": "https://example.com",
    "step": "https://example.com",
    "unit": "https://example.com",
    "closing_date": "2019-01-01",
    "description": "string",
    "is_archived": false,
    "is_value_auto_calculate": false,
    "label_flag": 1,
    "name": "string",
    "oppty_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "product_currency_id": "01234567-abcd-dcba-ffff-000000000000",
    "product_price_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "quick_account_email": "string",
    "quick_account_name": "string",
    "quick_account_phone": "string",
    "quick_contact_name": "string",
    "quick_email": "string",
    "quick_phone": "string",
    "ranking": 1,
    "reason_of_close_description": "string",
    "reason_of_close_id": "01234567-abcd-dcba-ffff-000000000000",
    "share_mode": 0,
    "step_id": "01234567-abcd-dcba-ffff-000000000000",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "was_qualified": false,
    "revision": 1,
    "value": {
      "base_value": "4.32",
      "currency_id": "01234567-abcd-dcba-ffff-000000000000",
      "value_foreign": "4.32"
    },
    "oppty_recurrence": "https://example.com",
    "revenue_schedule": "https://example.com",
    "product_relations": [
      "https://example.com"
    ],
    "primary_contact": "https://example.com",
    "primary_account": "https://example.com",
    "contact_relations": [
      "https://example.com"
    ],
    "account_relations": [
      "https://example.com"
    ],
    "documents": [
      "https://example.com"
    ],
    "status": 1,
    "qualify_date": "2019-01-01T00:00:00",
    "won_date": "2019-01-01T00:00:00",
    "lost_date": "2019-01-01T00:00:00",
    "days_in_step": 1,
    "is_favorite": false,
    "sharing_units": [
      "https://example.com"
    ],
    "sharing_clients": [
      "https://example.com"
    ],
    "fitness_description": {
      "is_won": false,
      "is_overdue": false,
      "activities_on_time": 1,
      "scheduled_activity": 1,
      "fitness": 1
    },
    "formatted_name": "string"
  }
}

{
    "closing_date": "2019-01-01",
    "name": "New Opportunity",
    "owner_id": "00000000-0000-0000-0000-000000011a7d",
    "step_id": "de115511-5dc1-46c3-86d9-f714457208dd",
    "value": {
        "base_value": 100,
        "currency_id": "c4ca4238-a0b9-0382-0dcc-509a6f75849b"
    },
    "account_relations": [
       {
           "account_id": "0bc376a4-c579-413a-9221-e86e4a134766",
           "is_primary": true
           
       }
    ],
    "contact_relations": [
       {
           "contact_id": "02bdc9f6-4dfb-479e-84ba-f6c3b96c39ba",
           "is_primary":true
       }
    ]
}

Opportunity inside the Pipeliner Application

Possible problems

Error description	Resolution
Error on field account_relations. Exactly one 'is_primary' item must be set.	Use is_primary flag for Account/Contact relation object. -When creating account relations at least one Account needs to be primary -When creating contact relations at least one Contact needs to be primary