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 works and you understand the of the Pipeliner API, and make sure you know how to use

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

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

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

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

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

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

get

Returns all defined Clients

Query parameters

include-deletedbooleanOptional

if enabled, deleted Clients are returned as well

firstinteger · int32Optional

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

lastinteger · int32Optional

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.

beforebooleanOptional

Cursor until which to take entities to result set.

afterbooleanOptional

Cursor after which to start taking entities to result set.

expandstringOptional

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-bystringOptional

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

filterobjectOptional

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-opobjectOptional

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-onlystringOptional

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

200

list of Clients

application/json

500

unexpected error

application / json

get

GET /api/v100/rest/spaces/<space_id>/entities/Clients HTTP/1.1
Host: us-east.pipelinersales.com
Accept: */*

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

post

Creates new account

Query parameters

validation-levelinteger · int32Optional

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-timeRead-onlyOptional

Last modification time.

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

createdstring · date-timeOptional

Creation time.

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

account_classinteger · enumOptional

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

Example: 1Possible values:

account_type_idstring · uuidOptional

Relation to single entity instance.

Example: 01234567-abcd-dcba-ffff-000000000000

addressstringOptional

Multi-line text input field.

Example: string

citystringOptional

Simple text input field.

Example: string

commentsstringOptional

Multi-line text input field.

Example: string

countrystringOptional

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

Example: string

customer_type_idstring · uuidOptional

Relation to single entity instance.

Example: 01234567-abcd-dcba-ffff-000000000000

email1stringOptional

Email address.

Example: string

email2stringOptional

Email address.

Example: string

email3stringOptional

Email address.

Example: string

email4stringOptional

Email address.

Example: string

email5stringOptional

Email address.

Example: string

home_pagestringOptional

URL - HTTP address.

Example: string

industry_idstring · uuidOptional

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 · uuidOptional

Relation to single entity instance.

Example: 01234567-abcd-dcba-ffff-000000000000

parent_account_relation_type_idstring · uuidOptional

Relation to single entity instance.

Example: 01234567-abcd-dcba-ffff-000000000000

phone1stringOptional

Phone number.

Example: string

phone2stringOptional

Phone number.

Example: string

phone3stringOptional

Phone number.

Example: string

phone4stringOptional

Phone number.

Example: string

phone5stringOptional

Phone number.

Example: string

picture_idstring · uuidOptional

Relation to single entity instance.

Example: 01234567-abcd-dcba-ffff-000000000000

quick_parent_account_namestringOptional

Simple text input field.

Example: string

share_modeinteger · enumOptional

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

Example: 0Possible values:

state_provincestringOptional

Simple text input field.

Example: string

unit_idstring · uuidOptional

Relation to single entity instance.

Example: 01234567-abcd-dcba-ffff-000000000000

zip_codestringOptional

Simple text input field.

Example: string

revisioninteger · int32Optional

Revision when entity was lastly changed.

Example: 1

is_unsubscribedbooleanOptional

If account has any unsubscribed email.

Example: false

Responses

201

Creation confirmation. Returns created account

application/json

500

unexpected error

application / json

post

POST /api/v100/rest/spaces/<space_id>/entities/Accounts HTTP/1.1
Host: us-east.pipelinersales.com
Content-Type: application / json
Accept: */*
Content-Length: 1150

{
  "created": "2019-01-01T00:00:00",
  "picture": {
    "id": "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",
  "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,
  "social_media": {
    "id": "https://example.com"
  },
  "sharing_units": [
    {
      "id": "https://example.com"
    }
  ],
  "sharing_clients": [
    {
      "id": "https://example.com"
    }
  ],
  "documents": [
    {
      "id": "https://example.com"
    }
  ],
  "is_unsubscribed": false
}

{
  "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,
    "health": {}
  }
}