Create Account

This tutorial should help you create the first Account. 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 Account represents the Company/organization, that your company is dealing with. Go to the web Application and Accounts can be located on the Accounts screen.

Tutorial Assignment

Create an Account in Pipeliner with Several Contacts (with bulk create method). For this account, we will set the industry field to Agriculture

0. Required fields

Required API field Name

Description

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 Account.

Returns all defined Clients

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

Query parameters

Response

list of Clients

Body

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

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]=john.doe@example.com

{
            "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 an Account with the default User´s sales unit. (See step 2. of this tutorial)

Industry

We need to retrieve existing values of Industry field. For more information how to work with fields and get values read Fields section.

GET 
{{baseUrl}}/entities/Fields?expand=data_set&load-only=api_name,data_set.option_name,data_set.id&filter[api_name]=industry_id

"data": [
        {
           "api_name": "industry_id",
           "data_set": [
                {
                    "id": "36430b74-f0ae-01b0-bc4a-47d6235f9405",
                    "option_name": "Accounting"
                },
                {
                    "id": "3e046e52-00e4-097b-b2a4-b58af0381541",
                    "option_name": "Agriculture"
                },
                {
                    "id": "acbda72f-2054-0b71-9d42-cb35aaa37600",
                    "option_name": "Broadcasting"
                },
                ...
    }
 ]

2. Create Account

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

Creates new account

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

Query parameters

Body

data of new Account

modifiedstring (date-time)

Last modification time.

createdstring (date-time)

Creation time.

pictureobject

Relation to CloudObject, see: 'createCloudObjectInput' object for properties.

account_classenum

Integer enum value: 1 - NoClass, 2 - ClassA, 3 - ClassB, 4 - ClassC, 5 - ClassD

12345

account_type_idstring (uuid)

Relation to single entity instance.

addressstring

Multi-line text input field.

citystring

Simple text input field.

commentsstring

Multi-line text input field.

countrystring

Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields.

customer_type_idstring (uuid)

Relation to single entity instance.

email1string

Email address.

email2string

Email address.

email3string

Email address.

email4string

Email address.

email5string

Email address.

home_pagestring

URL - HTTP address.

industry_idstring (uuid)

Relation to single entity instance.

name*string

Name of the entity and its default text representation.

owner_id*string (uuid)

Relation to single entity instance.

parent_account_idstring (uuid)

Relation to single entity instance.

parent_account_relation_type_idstring (uuid)

Relation to single entity instance.

phone1string

Phone number.

phone2string

Phone number.

phone3string

Phone number.

phone4string

Phone number.

phone5string

Phone number.

picture_idstring (uuid)

Relation to single entity instance.

quick_parent_account_namestring

Simple text input field.

share_modeenum

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

0123

state_provincestring

Simple text input field.

unit_idstring (uuid)

Relation to single entity instance.

zip_codestring

Simple text input field.

revisioninteger (int32)

Revision when entity was lastly changed.

social_mediaobject

Relation to AccountSocialRelation, see: 'createAccountSocialRelationInput' object for properties.

sharing_unitsarray of object

Relations to SalesUnits.

sharing_clientsarray of object

Relations to Clients.

documentsarray of object

Relations to CloudObjects.

is_unsubscribedboolean

If account has any unsubscribed email.

Response

Creation confirmation. Returns created account

Body

successboolean

True when response succeeded, false on error.

dataAccount (object)

Request

const response = await fetch('https://us-east.pipelinersales.com/api/v100/rest/spaces/<space_id>/entities/Accounts', {
    method: 'POST',
    headers: {
      "Content-Type": "application / json"
    },
    body: JSON.stringify({
      "name": "string",
      "owner_id": "01234567-abcd-dcba-ffff-000000000000"
    }),
});
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_type": "https://example.com",
    "customer_type": "https://example.com",
    "industry": "https://example.com",
    "owner": "https://example.com",
    "parent_account": "https://example.com",
    "parent_account_relation_type": "https://example.com",
    "picture": "https://example.com",
    "unit": "https://example.com",
    "account_class": 1,
    "account_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "address": "string",
    "city": "string",
    "comments": "string",
    "country": "string",
    "customer_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "email1": "string",
    "email2": "string",
    "email3": "string",
    "email4": "string",
    "email5": "string",
    "health_category": "01234567-abcd-dcba-ffff-000000000000",
    "health_status": 1,
    "home_page": "string",
    "industry_id": "01234567-abcd-dcba-ffff-000000000000",
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "parent_account_id": "01234567-abcd-dcba-ffff-000000000000",
    "parent_account_relation_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "phone1": "string",
    "phone2": "string",
    "phone3": "string",
    "phone4": "string",
    "phone5": "string",
    "picture_id": "01234567-abcd-dcba-ffff-000000000000",
    "quick_parent_account_name": "string",
    "share_mode": 0,
    "state_province": "string",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "zip_code": "string",
    "revision": 1,
    "formatted_name": "string",
    "social_media": "https://example.com",
    "sharing_units": [
      "https://example.com"
    ],
    "sharing_clients": [
      "https://example.com"
    ],
    "documents": [
      "https://example.com"
    ],
    "is_favorite": false,
    "is_unsubscribed": false
  }
}

{
    "name": "My New Account",
    "owner_id": "00000000-0000-0000-0000-000000011a7d",
    "industry_id": "3e046e52-00e4-097b-b2a4-b58af0381541"
}

When working with Dropdown fields like industry_id you need to use a relation to the id of the value in field data_set. In our case Option Agriculture has id 3e046e52-00e4-097b-b2a4-b58af0381541

PreviousWebhooks(Real-time updates)NextCreate Contact

Last updated 2 years ago