Fields

Fields offer Pipeliner users the opportunity to add detailed information to the Entities - for example, Account Name, Address, Website, Phone numbers for Accounts and Opportunity Name, Close Date, Value for Opportunities. Learn more about how to manage fields in Pipeliner
Manage fields in Administration -> Fields & Forms -> Select Entity -> FieldsS
To view fields inside Pipeliner Interface, you need to move the field to the Entity form.
System & Custom Fields
System fields are automatically included in Pipeliner. These fields can´t be deleted.
Custom fields are defined by business/user. The business can create the fields based on their needs in the Administration.
Field Properties
Api Field Name - API name of the field. When working with API this is the name of the field, that you will use in the request/response
Type - Pipeliner supports several field types (dropdowns, date fields, line inputs etc.)
Field name - Name of the field in the Pipeliner Application
Creating & Updating Custom Fields
As a developer, you have an option to create custom fields through API. Not every field can be created through API though. In the table below you can find a list of supported fields.
List of Supported fields
Name
Type_id
Single Line text
input
Long Text
text_area
Dropdown
dropdown
Checkbox
checkbox
Multi select checkox
multiselect_checkbox
Radio Button
radio
Base Currency
currency
Multiple Currencies
currency_foreign
Date
date
DateTime
datetime
Float Number
float
Integer Number
integer
Autonumber
sequence
Url
url
Email
email
Phone
phone
post
https://us-east.pipelinersales.com/api/v100/rest/spaces/<space_id>
/entities/Fields
1
POST {{baseUrl}}/entities/Fields
2
{
3
    "name": "Dropdown field example",
4
    "type_id": "dropdown",
5
    "entity_name": "Account",
6
    "data_set": [
7
        {"option_name": "Option 1", "calc_value": 1},
8
        {"option_name": "Option 2", "calc_value": 2},
9
        {"option_name": "Option 3", "calc_value": 3},
10
    ]
11
}
Copied!
calc_value - For Dropdowns, Multi-select checkbox, Radio is required. Every option has a value and when this option is used in calculated field, it is calculated with this value. If you don´t plan to use options with calculated fields, you can just use "1" for all calc_values
entity_name - Account, Contact, Lead, Opportunity, Product, LeadOpptyProductRelation (Product Line Items), Task, Appointment, Project
Update Existing custom field
For example, when you want to add a new option to the dropdown, you can update the existing custom field
patch
https://us-east.pipelinersales.com/api/v100/rest/spaces/<space_id>
/entities/Fields/{id}
1
Patch {{baseUrl}}/entities/<field_id>
2
{
3
    "name": "Updated Dropdown field example",
4
    "data_set": [
5
        {"id": "123456"}, // id of existing dropdown option 1
6
        {"id": "654321"}, // id of existing dropdown option 2
7
        {"id": "456789", "optiona_name": "Updated Option 3"}, // id of existing dropdown option 3
8
        {"option_name": "New Option 4", "calc_value": 3},  // new dropdown option 4
9
    ]
10
}
Copied!
Get All fields
To retrieve all fields use the following endpoint. Every field has a unique identification api_name. This is how you can filter fields, that you need to work with
get
https://us-east.pipelinersales.com/api/v100/rest/spaces/<space_id>
/entities/Fields
1
"data": [
2
        {
3
            "is_delete_protected": false,
4
            "has_draft": false,
5
            "id": "00000001-0001-a001-0040-000000000001",
6
            "is_deleted": false,
7
            "modified": "2020-09-21 10:16:11.968255+00:00",
8
            "created": "2020-09-21 10:16:12.334879+00:00",
9
            "entity_name": "Task",
10
            "api_name": "sf_jira_issue_link2",
11
            "name": "Jira Issue Link",
12
            "use_lang": 0,
13
            "column_name": "sf_jira_issue_link2_2",
14
            "column_source": 3,
15
       }
16
]
Copied!
Get Field Values
To get specific field valuies use a combination of API paremeters and {{baseURL}}/entities/Fields endpoint
Example
In this example we want to retrieve the values of the dropdown field with api field name industry_id. We use filter, one of the API parameters to find specific field by api_name.
1
GET 
2
{{baseUrl}}/entities/Fields?expand=data_set&load-only=api_name,data_set.option_name&filter[api_name]=industry_id
Copied!
1
"data": [
2
        {
3
            "api_name": "industry_id",
4
            "data_set": [
5
                {
6
                    "option_name": "Accounting"
7
                },
8
                {
9
                    "option_name": "Agriculture"
10
                },
11
                {
12
                    "option_name": "Broadcasting"
13
                }
14
                ...
15
    }
16
 ]       
17
                
18
                
Copied!

Core API Concepts - Previous

Understanding the CRM Concept

Next - Core API Concepts

API parameters

Last modified 4mo ago

Copy link

Contents

Creating & Updating Custom Fields

post

/entities/Fields

patch

/entities/Fields/{id}