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.
Create an Account in Pipeliner with Several Contacts (with bulk create method). For this account, we will set the
industry field to AgricultureRequired API field Name | Description |
|---|---|
name | Name of the Account |
owner_id | Id of the User in Pipeliner Application |
Load an id of the user with the default sales unit. This user will become the owner of the newly created Account.
get
https://us-east.pipelinersales.com/api/v100/rest/spaces/<space_id>
/entities/Clients
{{baseUrl}}/entities/Clients?load-only=id,default_unit_id&filter[email][email protected]
{
"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)
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"
},
...
}
]
Let´s Take data from Step 1. and use them in the following request to create a Contact.
post
https://us-east.pipelinersales.com/api/v100/rest/spaces/<space_id>
/entities/Accounts
{
"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