Create Account

PreviousWebhooks(Real-time updates)NextCreate Contact

Last updated 3 years ago

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

name

Name of the Account

owner_id

Id of the User in Pipeliner Application

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.

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

{
    "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 3 years ago

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

name

Name of the Account

owner_id

Id of the User in Pipeliner Application

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.

{{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"
}

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.

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

Returns all defined Clients

get

/entities/Clients

Query parameters

include-deletedboolean

if enabled, deleted Clients are returned as well

firstinteger · int32

Number of entities to return from beginning of the result set. Max: 100. Default: 30

lastinteger · int32

Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.

beforeboolean

Cursor until which to take entities to result set.

afterboolean

Cursor after which to start taking entities to result set.

expandstring

Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.

Example: expand=owner,sales_unit,account_relations.account

order-bystring

Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.

Example: order-by=created,-modified

filterobject

Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.

Example: filter[name]=Example

filter-opobject

Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].

Example: filter-op[name]=eq

load-onlystring

Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.

Example: load-only=id,name,owner.id

Responses

application/json

application / json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://us-east.pipelinersales.com/api/v100/rest/spaces/<space_id>/entities/Clients'

200

500

{
  "success": true,
  "data": [],
  "page_info": {
    "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
    "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
    "has_previous_page": true,
    "has_next_page": true
  }
}

list of Clients

Creates new account

post

/entities/Accounts

Query parameters

validation-levelinteger · int32

Specify validation level of account on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Body

modifiedstring · date-time

Last modification time.

Example: 2019-01-01T00:00:00

createdstring · date-time

Creation time.

Example: 2019-01-01T00:00:00

account_type_idstring · uuid

Relation to single entity instance.

Example: 01234567-abcd-dcba-ffff-000000000000

addressstring

Multi-line text input field.

Example: string

citystring

Simple text input field.

Example: string

commentsstring

Multi-line text input field.

Example: string

countrystring

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

Example: string

customer_type_idstring · uuid

Relation to single entity instance.

Example: 01234567-abcd-dcba-ffff-000000000000

email1string

Email address.

Example: string

email2string

Email address.

Example: string

email3string

Email address.

Example: string

email4string

Email address.

Example: string

email5string

Email address.

Example: string

home_pagestring

URL - HTTP address.

Example: string

industry_idstring · uuid

Relation to single entity instance.

Example: 01234567-abcd-dcba-ffff-000000000000

namestringrequired

Name of the entity and its default text representation.

Example: string

owner_idstring · uuidrequired

Relation to single entity instance.

Example: 01234567-abcd-dcba-ffff-000000000000

parent_account_idstring · uuid

Relation to single entity instance.

Example: 01234567-abcd-dcba-ffff-000000000000

parent_account_relation_type_idstring · uuid

Relation to single entity instance.

Example: 01234567-abcd-dcba-ffff-000000000000

phone1string

Phone number.

Example: string

phone2string

Phone number.

Example: string

phone3string

Phone number.

Example: string

phone4string

Phone number.

Example: string

phone5string

Phone number.

Example: string

picture_idstring · uuid

Relation to single entity instance.

Example: 01234567-abcd-dcba-ffff-000000000000

quick_parent_account_namestring

Simple text input field.

Example: string

state_provincestring

Simple text input field.

Example: string

unit_idstring · uuid

Relation to single entity instance.

Example: 01234567-abcd-dcba-ffff-000000000000

zip_codestring

Simple text input field.

Example: string

revisioninteger · int32

Revision when entity was lastly changed.

Example: 1

is_unsubscribedboolean

If account has any unsubscribed email.

Example: false

account_classinteger · enum

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

Example: 1

Options: 1, 2, 3, 4, 5

share_modeinteger · enum

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

Example: 0

Options: 0, 1, 2, 3

pictureobject

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

social_mediaobject

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

sharing_unitsobject[]

Relation to AccountSharingSalesUnitRelation, see: 'createAccountSharingSalesUnitRelationInput' object for properties.

sharing_clientsobject[]

Relation to AccountSharingClientRelation, see: 'createAccountSharingClientRelationInput' object for properties.

documentsobject[]

Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties.

Responses

application/json

application / json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://us-east.pipelinersales.com/api/v100/rest/spaces/<space_id>/entities/Accounts' \
  --header 'Content-Type: application / json' \
  --data '{
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "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",
    "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",
    "state_province": "string",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "zip_code": "string",
    "revision": 1,
    "is_unsubscribed": false,
    "account_class": 1,
    "share_mode": 0,
    "picture": {
      "id": "https://example.com"
    },
    "social_media": {
      "id": "https://example.com"
    },
    "sharing_units": [
      {
        "id": "https://example.com"
      }
    ],
    "sharing_clients": [
      {
        "id": "https://example.com"
      }
    ],
    "documents": [
      {
        "id": "https://example.com"
      }
    ]
  }'

201

500

{
  "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_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",
    "state_province": "string",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "zip_code": "string",
    "revision": 1,
    "formatted_name": "string",
    "social_media": "https://example.com",
    "is_favorite": false,
    "is_unsubscribed": false,
    "health": {},
    "account_class": 1,
    "share_mode": 0,
    "sharing_units": [
      "https://example.com"
    ],
    "sharing_clients": [
      "https://example.com"
    ],
    "documents": [
      "https://example.com"
    ]
  }
}

Creation confirmation. Returns created account