Pipeliner CRM (Preview)
Pipeliner is a next generation sales CRM software designed to empower sales teams and grow profitable customer relationships. The connector provides an API to work with Pipeliner records.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Pipeliner CRM |
| URL | https://www.pipelinersales.com |
| support@pipelinersales.com |
| Connector Metadata | |
|---|---|
| Publisher | Pipelinersales, Inc. |
| Website | https://www.pipelinersales.com |
| Privacy policy | https://www.pipelinersales.com/privacy/ |
| Categories | Sales and CRM;Productivity |
Pipeliner is a next generation sales CRM software designed to empower sales teams and grow profitable customer relationships. The connector provides an API to work with Pipeliner records.
Prerequisites
You will need a Pipeliner CRM account.
How to get credentials
- Sign in to your Pipeliner CRM account.
- Select your space and go to the Administration.
- Under the Unit, Users & Roles tab open Applications.
- Create a new Application.
- Click on Show API Access to see your Username, Password, Service URL and Space ID.
Accessing the Pipeliner API credentials
Get started with your connector
- If you use the connector for the first time, you will be asked to enter your API Username and Password.
- Choose one of available actions to work with Pipeliner records.
- Enter your Service URL and Space ID to allow the loading of some dropdown items.
- Dynamic content and expressions can be used to create an advanced flow.
Known issues and limitations
The API returns a maximum of 100 records per request.
Common errors and remedies
Fill the Service URL and Space ID fields first, to allow the loading of dynamic content in some fields.
FAQ
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| User Name | securestring | Enter your API user name | True |
| Password | securestring | Enter your API password | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Create Account |
Creates new account. |
| Create Contact |
Creates new contact. |
| Create Lead |
Creates new lead. |
| Create Opportunity |
Creates new opportunity. |
| Create Task |
Creates new task. |
| Delete Account |
Removes account with given ID. |
| Delete Contact |
Removes contact with given ID. |
| Delete Lead |
Removes lead with given ID. |
| Delete Opportunity |
Removes opportunity with given ID. |
| Delete Task |
Removes task with given ID. |
| Get Account |
Returns account with given ID. |
| Get Contact |
Returns contact with given ID. |
| Get Lead |
Returns lead with given ID. |
| Get Opportunity |
Returns opportunity with given ID. |
| Get Task |
Get task with given ID. |
| Update Account |
Modifies account or accounts with given ID(s). |
| Update Contact |
Modifies contact or contacts with given ID(s). |
| Update Lead |
Modifies lead or leads with given ID(s). |
| Update Opportunity |
Modifies opportunity or opportunities with given ID(s). |
| Update Task |
Modifies task or tasks with given ID(s). |
Create Account
Creates new account.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
Your Service URL starting with https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Account Name
|
name | True | string | |
|
Owner ID
|
owner_id | True | string |
ID |
|
Account Type ID
|
account_type_id | string |
ID |
|
|
Sales Unit ID
|
unit_id | string |
ID |
|
|
Account Class
|
account_class | integer |
1 - No Class, 2 - Class A, 3 - Class B, 4 - Class C, 5 - Class D |
|
|
Primary E-mail
|
email1 | string |
E-mail address |
|
|
Primary Phone
|
phone1 | string |
Phone number |
|
|
Homepage
|
home_page | string |
URL |
|
|
Address
|
address | string | ||
|
City
|
city | string | ||
|
Country
|
country | string | ||
|
State / Province
|
state_province | string | ||
|
ZIP Code
|
zip_code | string | ||
|
Comments
|
comments | string |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
Is Delete Protected
|
data.is_delete_protected | boolean | |
|
Account ID
|
data.id | string | |
|
Is Deleted
|
data.is_deleted | boolean | |
|
Date Modified
|
data.modified | string | |
|
Date Created
|
data.created | string | |
|
Account Type
|
data.account_type | string | |
|
Customer Type
|
data.customer_type | string | |
|
Industry
|
data.industry | string | |
|
Owner
|
data.owner | string | |
|
Parent Account
|
data.parent_account | string | |
|
Parent Account Relation Type
|
data.parent_account_relation_type | string | |
|
Picture
|
data.picture | string | |
|
Unit
|
data.unit | string | |
|
Account Class
|
data.account_class | integer | |
|
Account Type ID
|
data.account_type_id | string | |
|
Address
|
data.address | string | |
|
City
|
data.city | string | |
|
Comments
|
data.comments | string | |
|
Country
|
data.country | string | |
|
Customer Type ID
|
data.customer_type_id | string | |
|
Primary E-mail
|
data.email1 | string | |
|
E-mail 2
|
data.email2 | string | |
|
E-mail 3
|
data.email3 | string | |
|
E-mail 4
|
data.email4 | string | |
|
E-mail 5
|
data.email5 | string | |
|
Health Category
|
data.health_category | string | |
|
Health Status
|
data.health_status | integer | |
|
Home Page
|
data.home_page | string | |
|
Industry ID
|
data.industry_id | string | |
|
Account Name
|
data.name | string | |
|
Owner ID
|
data.owner_id | string | |
|
Parent Account ID
|
data.parent_account_id | string | |
|
Parent Account Relation Type ID
|
data.parent_account_relation_type_id | string | |
|
Primary Phone
|
data.phone1 | string | |
|
Phone 2
|
data.phone2 | string | |
|
Phone 3
|
data.phone3 | string | |
|
Phone 4
|
data.phone4 | string | |
|
Phone 5
|
data.phone5 | string | |
|
Picture ID
|
data.picture_id | string | |
|
Quick Parent Account Name
|
data.quick_parent_account_name | string | |
|
Share Mode
|
data.share_mode | integer | |
|
State / Province
|
data.state_province | string | |
|
Sales Unit ID
|
data.unit_id | string | |
|
ZIP Code
|
data.zip_code | string | |
|
Revision
|
data.revision | integer | |
|
Formatted Name
|
data.formatted_name | string | |
|
Social Media
|
data.social_media | string | |
|
Sharing Units
|
data.sharing_units | array of string | |
|
Sharing Clients
|
data.sharing_clients | array of string | |
|
Documents
|
data.documents | array of string | |
|
Is Favorite
|
data.is_favorite | boolean | |
|
Is Unsubscribed
|
data.is_unsubscribed | boolean | |
|
Tags
|
data.tags | array of string | |
|
Modified By User
|
data.modified_by_user | string |
Create Contact
Creates new contact.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
Your Service URL starting with https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Title / Salutation
|
title | string | ||
|
First Name
|
first_name | string | ||
|
Middle Name
|
middle_name | string | ||
|
Last Name
|
last_name | True | string | |
|
Gender
|
gender | integer |
0 - Unknown, 1 - Male, 2 - Female, 3 - Non-binary |
|
|
Contact Type ID
|
contact_type_id | string |
ID |
|
|
Sales Unit ID
|
unit_id | string |
ID |
|
|
Owner ID
|
owner_id | True | string |
ID |
|
E-mail
|
email1 | string |
E-mail address |
|
|
Phone
|
phone1 | string |
Phone number |
|
|
Address
|
address | string | ||
|
City
|
city | string | ||
|
State / Province
|
state_province | string | ||
|
ZIP Code
|
zip_code | string | ||
|
Country
|
country | string | ||
|
Is Primary
|
is_primary | boolean | ||
|
Account ID
|
account_id | string |
ID |
|
|
Comments
|
comments | string |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
Is Delete Protected
|
data.is_delete_protected | boolean | |
|
Contact ID
|
data.id | string | |
|
Is Deleted
|
data.is_deleted | boolean | |
|
Date Modified
|
data.modified | string | |
|
Date Creted
|
data.created | string | |
|
Contact Type
|
data.contact_type | string | |
|
Owner
|
data.owner | string | |
|
Picture
|
data.picture | string | |
|
Unit
|
data.unit | string | |
|
Address
|
data.address | string | |
|
City
|
data.city | string | |
|
Comments
|
data.comments | string | |
|
Contact Type ID
|
data.contact_type_id | string | |
|
Country
|
data.country | string | |
|
Primary E-Mail
|
data.email1 | string | |
|
E-mail 2
|
data.email2 | string | |
|
E-mail 3
|
data.email3 | string | |
|
E-mail 4
|
data.email4 | string | |
|
E-mail 5
|
data.email5 | string | |
|
First Name
|
data.first_name | string | |
|
Gender
|
data.gender | integer |
0 - Unknown, 1 - Male, 2 - Female, 3 - Non-binary |
|
Last Name
|
data.last_name | string | |
|
Middle Name
|
data.middle_name | string | |
|
Owner ID
|
data.owner_id | string | |
|
Primary Phone
|
data.phone1 | string | |
|
Phone 2
|
data.phone2 | string | |
|
Phone 3
|
data.phone3 | string | |
|
Phone 4
|
data.phone4 | string | |
|
Phone 5
|
data.phone5 | string | |
|
Picture ID
|
data.picture_id | string | |
|
Position
|
data.position | string | |
|
Quick Account Name
|
data.quick_account_name | string | |
|
Share Mode
|
data.share_mode | integer | |
|
State / Province
|
data.state_province | string | |
|
Title
|
data.title | string | |
|
Unit ID
|
data.unit_id | string | |
|
ZIP Code
|
data.zip_code | string | |
|
Revision
|
data.revision | integer | |
|
Formatted Name
|
data.formatted_name | string | |
|
Social Media
|
data.social_media | string | |
|
Primary Account
|
data.primary_account | string | |
|
Account Relations
|
data.account_relations | array of string | |
|
Sharing Units
|
data.sharing_units | array of string | |
|
Sharing Clients
|
data.sharing_clients | array of string | |
|
Documents
|
data.documents | array of string | |
|
Is Favorite
|
data.is_favorite | boolean | |
|
Primary Account Roles
|
data.primary_account_account_roles | array of string | |
|
Primary Account Position
|
data.primary_account_position | string | |
|
Account Position
|
data.account_position | string | |
|
Is Unsubscribed
|
data.is_unsubscribed | boolean | |
|
Tags
|
data.tags | array of string | |
|
Primary Account Relationship
|
data.primary_account_relationship | integer | |
|
Modified By User
|
data.modified_by_user | string |
Create Lead
Creates new lead.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
Your Service URL starting with https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Creation Date
|
created | string |
Date and time |
|
|
Description
|
description | string | ||
|
Ranking
|
ranking | integer |
Number between 1 and 100 |
|
|
Lead Type ID
|
lead_type_id | string |
ID |
|
|
Lead Name
|
name | True | string | |
|
Owner ID
|
owner_id | True | string |
ID |
|
Step ID
|
step_id | string |
ID |
|
|
Sales Unit ID
|
unit_id | True | string |
ID |
|
Is Primary
|
is_primary | boolean | ||
|
Contact ID
|
contact_id | string |
ID |
|
|
Is Primary
|
is_primary | boolean | ||
|
Account ID
|
account_id | string |
ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
Is Delete Protected
|
data.is_delete_protected | boolean | |
|
Lead ID
|
data.id | string | |
|
Is Deleted
|
data.is_deleted | boolean | |
|
Date Created
|
data.created | string | |
|
Date Modified
|
data.modified | string | |
|
Lead Type
|
data.lead_type | string | |
|
Owner
|
data.owner | string | |
|
Reason of Close
|
data.reason_of_close | string | |
|
Step
|
data.step | string | |
|
Unit
|
data.unit | string | |
|
Description
|
data.description | string | |
|
Is Archived
|
data.is_archived | boolean | |
|
Label Flag
|
data.label_flag | integer | |
|
Lead Type ID
|
data.lead_type_id | string | |
|
Lead Name
|
data.name | string | |
|
Owner ID
|
data.owner_id | string | |
|
Quick Account E-mail
|
data.quick_account_email | string | |
|
Quick Account Name
|
data.quick_account_name | string | |
|
Quick Account Phone
|
data.quick_account_phone | string | |
|
Quick Contact Name
|
data.quick_contact_name | string | |
|
Quick E-mail
|
data.quick_email | string | |
|
Quick Phone
|
data.quick_phone | string | |
|
Ranking
|
data.ranking | integer | |
|
Reason of Close Description
|
data.reason_of_close_description | string | |
|
Reason of Close ID
|
data.reason_of_close_id | string | |
|
Share Mode
|
data.share_mode | integer | |
|
Step ID
|
data.step_id | string | |
|
Table Name
|
data.table_name | string | |
|
Sales Unit ID
|
data.unit_id | string | |
|
Revision
|
data.revision | integer | |
|
Primary Contact
|
data.primary_contact | string | |
|
Primary Account
|
data.primary_account | string | |
|
Contact Relations
|
data.contact_relations | array of string | |
|
Account Relations
|
data.account_relations | array of string | |
|
Status
|
data.status | integer |
1 - Open, 2 - Lost, 4 - Qualified |
|
Sharing Units
|
data.sharing_units | array of string | |
|
Sharing Clients
|
data.sharing_clients | array of string | |
|
Documents
|
data.documents | array of string | |
|
Tags
|
data.tags | array of string | |
|
Qualify Date
|
data.qualify_date | string | |
|
Days In Step
|
data.days_in_step | integer | |
|
Is Favorite
|
data.is_favorite | boolean | |
|
Lost Date
|
data.lost_date | string | |
|
Formatted Name
|
data.formatted_name | string | |
|
Modified By User
|
data.modified_by_user | string |
Create Opportunity
Creates new opportunity.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
Your Service URL starting with https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Opportunity Name
|
name | True | string | |
|
Creation Date
|
created | string | ||
|
Opportunity Value
|
base_value | True | number | |
|
Currency
|
currency_id | True | string | |
|
Foreign Value
|
value_foreign | number | ||
|
Closing date
|
closing_date | True | date | |
|
Description
|
description | string | ||
|
Ranking
|
ranking | integer |
Number between 1 and 100 |
|
|
Opportunity Type ID
|
oppty_type_id | True | string |
ID |
|
Step ID
|
step_id | True | string |
ID |
|
Sales Unit ID
|
unit_id | string |
ID |
|
|
Owner ID
|
owner_id | True | string |
ID |
|
Is Primary
|
is_primary | True | boolean | |
|
Account ID
|
account_id | True | string |
ID |
|
Is Primary
|
is_primary | boolean | ||
|
Contact ID
|
contact_id | string |
ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
Is Delete Protected
|
data.is_delete_protected | boolean | |
|
Opportunity ID
|
data.id | string | |
|
Is Deleted
|
data.is_deleted | boolean | |
|
Date Created
|
data.created | string | |
|
Date Modified
|
data.modified | string | |
|
Active Quote
|
data.active_quote | string | |
|
Opportunity Type
|
data.oppty_type | string | |
|
Owner
|
data.owner | string | |
|
Product Currenct
|
data.product_currency | string | |
|
Product Price List
|
data.product_price_list | string | |
|
Reason of Close
|
data.reason_of_close | string | |
|
Step
|
data.step | string | |
|
Unit
|
data.unit | string | |
|
Active Quote ID
|
data.active_quote_id | string | |
|
Closing Date
|
data.closing_date | string | |
|
Description
|
data.description | string | |
|
Is Archived
|
data.is_archived | boolean | |
|
Is Value Auto Calculate
|
data.is_value_auto_calculate | boolean | |
|
Label Flags
|
data.label_flag | integer | |
|
Opportunity Name
|
data.name | string | |
|
Opportunity Type ID
|
data.oppty_type_id | string | |
|
Owner ID
|
data.owner_id | string | |
|
Product Currency ID
|
data.product_currency_id | string | |
|
Product Price List ID
|
data.product_price_list_id | string | |
|
Quick Account Email
|
data.quick_account_email | string | |
|
Quick Account Name
|
data.quick_account_name | string | |
|
Quick Account Phone
|
data.quick_account_phone | string | |
|
Quick Contact Name
|
data.quick_contact_name | string | |
|
Quick Email
|
data.quick_email | string | |
|
Quick Phone
|
data.quick_phone | string | |
|
Ranking
|
data.ranking | integer | |
|
Reason of Close Description
|
data.reason_of_close_description | string | |
|
Reason of Close ID
|
data.reason_of_close_id | string | |
|
Share Mode
|
data.share_mode | integer | |
|
Step ID
|
data.step_id | string | |
|
Table Name
|
data.table_name | string | |
|
Unit ID
|
data.unit_id | string | |
|
Was Qualified
|
data.was_qualified | boolean | |
|
Revision
|
data.revision | integer | |
|
Base Value
|
data.value.base_value | number | |
|
Currency ID
|
data.value.currency_id | string | |
|
Value Foreign
|
data.value.value_foreign | number | |
|
Opportunity Recurrence
|
data.oppty_recurrence | string | |
|
Revenue Schedule
|
data.revenue_schedule | string | |
|
Product Relations
|
data.product_relations | array of string | |
|
Primary Contact
|
data.primary_contact | string | |
|
Primary Contact
|
data.primary_account | string | |
|
Contact Relations
|
data.contact_relations | array of string | |
|
Account Relations
|
data.account_relations | array of string | |
|
Documents
|
data.documents | array of string | |
|
Quote Relations
|
data.quote_relations | array of string | |
|
Status
|
data.status | integer | |
|
Qualify Date
|
data.qualify_date | string | |
|
Won Date
|
data.won_date | string | |
|
Lost Date
|
data.lost_date | string | |
|
Days In Step
|
data.days_in_step | integer | |
|
Is Favorite
|
data.is_favorite | boolean | |
|
Sharing Units
|
data.sharing_units | array of string | |
|
Sharing Clients
|
data.sharing_clients | array of string | |
|
Tags
|
data.tags | array of string | |
|
Formatted Name
|
data.formatted_name | string | |
|
Modified by User
|
data.modified_by_user | string |
Create Task
Creates new task.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
Your Service URL starting with https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Subject
|
subject | True | string | |
|
Task Type ID
|
activity_type_id | string |
ID |
|
|
Sales Unit ID
|
unit_id | True | string |
ID |
|
Owner ID
|
owner_id | True | string |
ID |
|
Description
|
description | string | ||
|
Due Date
|
due_date | date | ||
|
Priority
|
priority | integer |
1 - Low, 2 - Medium, 3 - High |
|
|
Status
|
status | integer |
1 - Not Started, 2 - In Progress, 3 - Waiting, 4 - Completed, 5 - Deferred |
|
|
Account ID
|
account_id | string |
ID |
|
|
Contact ID
|
contact_id | string |
ID |
|
|
Lead ID
|
lead_oppty_id | string | ||
|
Opportunity ID
|
lead_oppty_id | string |
ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
Is Delete Protected
|
data.is_delete_protected | boolean | |
|
Task ID
|
data.id | string | |
|
Active Reminder
|
data.active_reminder | string | |
|
Is Deleted
|
data.is_deleted | boolean | |
|
Date Created
|
data.created | string | |
|
Date Modified
|
data.modified | string | |
|
Activity Type
|
data.activity_type | string | |
|
Call Outcome
|
data.call_outcome | string | |
|
Owner
|
data.owner | string | |
|
Unit
|
data.unit | string | |
|
Activity Type ID
|
data.activity_type_id | string | |
|
Call Duration
|
data.call_duration | integer | |
|
Call Outcome ID
|
data.call_outcome_id | string | |
|
Description
|
data.description | string | |
|
Due Date
|
data.due_date | string | |
|
Duration
|
data.duration | string | |
|
Owner ID
|
data.owner_id | string | |
|
Priority
|
data.priority | integer |
1 - Low, 2 - Medium, 3 - High |
|
Share Mode
|
data.share_mode | integer | |
|
Start Date
|
data.start_date | string | |
|
Status
|
data.status | integer |
1 - Not Started, 2 - In Progress, 3 - Waiting, 4 - Completed, 5 - Deferred |
|
Task Subject
|
data.subject | string | |
|
Table Name
|
data.table_name | string | |
|
Sales Unit ID
|
data.unit_id | string | |
|
Revision
|
data.revision | integer | |
|
Sharing Units
|
data.sharing_units | array of string | |
|
Sharing Clients
|
data.sharing_clients | array of string | |
|
Account Relations
|
data.account_relations | array of string | |
|
Contact Relations
|
data.contact_relations | array of string | |
|
Lead Relations
|
data.lead_relations | array of string | |
|
Opportunity Relations
|
data.opportunity_relations | array of string | |
|
Project Relations
|
data.project_relations | array of string | |
|
Quote Relations
|
data.quote_relations | array of string | |
|
Reminder
|
data.reminder | string | |
|
Task Recurrence
|
data.task_recurrence | string | |
|
Documents
|
data.documents | array of string | |
|
Comments
|
data.comments | array of string | |
|
Formatted Name
|
data.formatted_name | string | |
|
Modified By User
|
data.modified_by_user | string |
Delete Account
Removes account with given ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
Your Service URL starting with https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Account ID
|
id | True | string |
ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
ID
|
data | string |
Delete Contact
Removes contact with given ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
Your Service URL starting with https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Contact ID
|
id | True | string |
ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
ID
|
data | string |
Delete Lead
Removes lead with given ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
Your Service URL starting with https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Lead ID
|
id | True | string |
ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
ID
|
data | string |
Delete Opportunity
Removes opportunity with given ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
Your Service URL starting with https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Opportunity ID
|
id | True | string |
ID of the Opportunity |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
ID
|
data | string |
Delete Task
Removes task with given ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
Your Service URL starting with https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Task ID
|
id | True | string |
ID of the Task |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
ID
|
data | string |
Get Account
Returns account with given ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
Your Service URL starting with https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Account ID
|
id | True | string |
ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
Is Delete Protected
|
data.is_delete_protected | boolean | |
|
Account ID
|
data.id | string | |
|
Is Deleted
|
data.is_deleted | boolean | |
|
Date Created
|
data.created | string | |
|
Date Modified
|
data.modified | string | |
|
Account Type
|
data.account_type | string | |
|
Customer Type
|
data.customer_type | string | |
|
Industry
|
data.industry | string | |
|
Owner
|
data.owner | string | |
|
Parent Account
|
data.parent_account | string | |
|
Parent Account Relation Type
|
data.parent_account_relation_type | string | |
|
Picture
|
data.picture | string | |
|
Sales Unit ID
|
data.unit | string | |
|
Account Class
|
data.account_class | integer | |
|
Account Type ID
|
data.account_type_id | string | |
|
Address
|
data.address | string | |
|
City
|
data.city | string | |
|
Comments
|
data.comments | string | |
|
Country
|
data.country | string | |
|
Customer Type ID
|
data.customer_type_id | string | |
|
Primary E-mail
|
data.email1 | string | |
|
E-mail 2
|
data.email2 | string | |
|
E-mail 3
|
data.email3 | string | |
|
E-mail 4
|
data.email4 | string | |
|
E-mail 5
|
data.email5 | string | |
|
Health Category
|
data.health_category | string | |
|
Health Status
|
data.health_status | integer | |
|
Home Page
|
data.home_page | string | |
|
Industry ID
|
data.industry_id | string | |
|
Account Name
|
data.name | string | |
|
Owner ID
|
data.owner_id | string | |
|
Parent Account ID
|
data.parent_account_id | string | |
|
Parent Account Relation Type ID
|
data.parent_account_relation_type_id | string | |
|
Primary Phone
|
data.phone1 | string | |
|
Phone 2
|
data.phone2 | string | |
|
Phone 3
|
data.phone3 | string | |
|
Phone 4
|
data.phone4 | string | |
|
Phone 5
|
data.phone5 | string | |
|
Picture ID
|
data.picture_id | string | |
|
Quick Parent Account Name
|
data.quick_parent_account_name | string | |
|
Share Mode
|
data.share_mode | integer | |
|
State / Province
|
data.state_province | string | |
|
Sales Unit ID
|
data.unit_id | string | |
|
ZIP Code
|
data.zip_code | string | |
|
Revision
|
data.revision | integer | |
|
Formatted Name
|
data.formatted_name | string | |
|
Social Media
|
data.social_media | string | |
|
Sharing Units
|
data.sharing_units | array of string | |
|
Sharing Clients
|
data.sharing_clients | array of string | |
|
Documents
|
data.documents | array of string | |
|
Is Favorite
|
data.is_favorite | boolean | |
|
Is Unsubscribed
|
data.is_unsubscribed | boolean | |
|
Tags
|
data.tags | array of string | |
|
Modified By User
|
data.modified_by_user | string |
Get Contact
Returns contact with given ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
Your Service URL starting with https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Contact ID
|
id | True | string |
ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
Is Delete Protected
|
data.is_delete_protected | boolean | |
|
Contact ID
|
data.id | string | |
|
Is Deleted
|
data.is_deleted | boolean | |
|
Date Modified
|
data.modified | string | |
|
Date Creted
|
data.created | string | |
|
Contact Type
|
data.contact_type | string | |
|
Owner
|
data.owner | string | |
|
Picture
|
data.picture | string | |
|
Unit
|
data.unit | string | |
|
Address
|
data.address | string | |
|
City
|
data.city | string | |
|
Comments
|
data.comments | string | |
|
Contact Type ID
|
data.contact_type_id | string | |
|
Country
|
data.country | string | |
|
Primary E-Mail
|
data.email1 | string | |
|
E-mail 2
|
data.email2 | string | |
|
E-mail 3
|
data.email3 | string | |
|
E-mail 4
|
data.email4 | string | |
|
E-mail 5
|
data.email5 | string | |
|
First Name
|
data.first_name | string | |
|
Last Name
|
data.last_name | string | |
|
Middle Name
|
data.middle_name | string | |
|
Gender
|
data.gender | integer |
0 - Unknown, 1 - Male, 2 - Female, 3 - Non-binary |
|
Owner ID
|
data.owner_id | string | |
|
Primary Phone
|
data.phone1 | string | |
|
Phone 2
|
data.phone2 | string | |
|
Phone 3
|
data.phone3 | string | |
|
Phone 4
|
data.phone4 | string | |
|
Phone 5
|
data.phone5 | string | |
|
Picture ID
|
data.picture_id | string | |
|
Position
|
data.position | string | |
|
Quick Account Name
|
data.quick_account_name | string | |
|
Share Mode
|
data.share_mode | integer | |
|
State / Province
|
data.state_province | string | |
|
Title
|
data.title | string | |
|
Unit ID
|
data.unit_id | string | |
|
ZIP Code
|
data.zip_code | string | |
|
Revision
|
data.revision | integer | |
|
Formatted Name
|
data.formatted_name | string | |
|
Social Media
|
data.social_media | string | |
|
Primary Account
|
data.primary_account | string | |
|
Account Relations
|
data.account_relations | array of string | |
|
Sharing Units
|
data.sharing_units | array of string | |
|
Sharing Clients
|
data.sharing_clients | array of string | |
|
Documents
|
data.documents | array of string | |
|
Is Favorite
|
data.is_favorite | boolean | |
|
Primary Account Roles
|
data.primary_account_account_roles | array of string | |
|
Primary Account Position
|
data.primary_account_position | string | |
|
Account Position
|
data.account_position | string | |
|
Is Unsubscribed
|
data.is_unsubscribed | boolean | |
|
Tags
|
data.tags | array of string | |
|
Primary Account Relationship
|
data.primary_account_relationship | integer | |
|
Modified By User
|
data.modified_by_user | string |
Get Lead
Returns lead with given ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
Your Service URL starting with https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Lead ID
|
id | True | string |
ID of the Lead |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
Is Delete Protected
|
data.is_delete_protected | boolean | |
|
Lead ID
|
data.id | string | |
|
Is Deleted
|
data.is_deleted | boolean | |
|
Date Created
|
data.created | string | |
|
Date Modified
|
data.modified | string | |
|
Lead Type
|
data.lead_type | string | |
|
Owner
|
data.owner | string | |
|
Reason of Close
|
data.reason_of_close | string | |
|
Step
|
data.step | string | |
|
Unit
|
data.unit | string | |
|
Description
|
data.description | string | |
|
Is Archived
|
data.is_archived | boolean | |
|
Label Flag
|
data.label_flag | integer | |
|
Lead Type ID
|
data.lead_type_id | string | |
|
Lead Name
|
data.name | string | |
|
Owner ID
|
data.owner_id | string | |
|
Quick Account E-mail
|
data.quick_account_email | string | |
|
Quick Account Name
|
data.quick_account_name | string | |
|
Quick Account Phone
|
data.quick_account_phone | string | |
|
Quick Contact Name
|
data.quick_contact_name | string | |
|
Quick E-mail
|
data.quick_email | string | |
|
Quick Phone
|
data.quick_phone | string | |
|
Ranking
|
data.ranking | integer | |
|
Reason of Close Description
|
data.reason_of_close_description | string | |
|
Reason of Close ID
|
data.reason_of_close_id | string | |
|
Share Mode
|
data.share_mode | integer | |
|
Step ID
|
data.step_id | string | |
|
Table Name
|
data.table_name | string | |
|
Sales Unit ID
|
data.unit_id | string | |
|
Revision
|
data.revision | integer | |
|
Primary Contact
|
data.primary_contact | string | |
|
Primary Account
|
data.primary_account | string | |
|
Contact Relations
|
data.contact_relations | array of string | |
|
Account Relations
|
data.account_relations | array of string | |
|
Status
|
data.status | integer |
1 - Open, 2 - Lost, 4 - Qualified |
|
Sharing Units
|
data.sharing_units | array of string | |
|
Sharing Clients
|
data.sharing_clients | array of string | |
|
Documents
|
data.documents | array of string | |
|
Tags
|
data.tags | array of string | |
|
Qualify Date
|
data.qualify_date | string | |
|
Days In Step
|
data.days_in_step | integer | |
|
Is Favorite
|
data.is_favorite | boolean | |
|
Lost Date
|
data.lost_date | string | |
|
Formatted Name
|
data.formatted_name | string | |
|
Modified By User
|
data.modified_by_user | string |
Get Opportunity
Returns opportunity with given ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
Your Service URL starting with https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Opportunity ID
|
id | True | string |
ID of the Opportunity |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
Is Delete Protected
|
data.is_delete_protected | boolean | |
|
Opportunity ID
|
data.id | string | |
|
Is Deleted
|
data.is_deleted | boolean | |
|
Date Created
|
data.created | string | |
|
Date Modified
|
data.modified | string | |
|
Active Quote
|
data.active_quote | string | |
|
Opportunity Type
|
data.oppty_type | string | |
|
Owner
|
data.owner | string | |
|
Product Currenct
|
data.product_currency | string | |
|
Product Price List
|
data.product_price_list | string | |
|
Reason of Close
|
data.reason_of_close | string | |
|
Step
|
data.step | string | |
|
Unit
|
data.unit | string | |
|
Active Quote ID
|
data.active_quote_id | string | |
|
Closing Date
|
data.closing_date | string | |
|
Description
|
data.description | string | |
|
Is Archived
|
data.is_archived | boolean | |
|
Is Value Auto Calculate
|
data.is_value_auto_calculate | boolean | |
|
Label Flags
|
data.label_flag | integer | |
|
Opportunity Name
|
data.name | string | |
|
Opportunity Type ID
|
data.oppty_type_id | string | |
|
Owner ID
|
data.owner_id | string | |
|
Product Currency ID
|
data.product_currency_id | string | |
|
Product Price List ID
|
data.product_price_list_id | string | |
|
Quick Account Email
|
data.quick_account_email | string | |
|
Quick Account Name
|
data.quick_account_name | string | |
|
Quick Account Phone
|
data.quick_account_phone | string | |
|
Quick Contact Name
|
data.quick_contact_name | string | |
|
Quick Email
|
data.quick_email | string | |
|
Quick Phone
|
data.quick_phone | string | |
|
Ranking
|
data.ranking | integer | |
|
Reason of Close Description
|
data.reason_of_close_description | string | |
|
Reason of Close ID
|
data.reason_of_close_id | string | |
|
Share Mode
|
data.share_mode | integer | |
|
Step ID
|
data.step_id | string | |
|
Table Name
|
data.table_name | string | |
|
Unit ID
|
data.unit_id | string | |
|
Was Qualified
|
data.was_qualified | boolean | |
|
Revision
|
data.revision | integer | |
|
Base Value
|
data.value.base_value | number | |
|
Currency ID
|
data.value.currency_id | string | |
|
Value Foreign
|
data.value.value_foreign | number | |
|
Opportunity Recurrence
|
data.oppty_recurrence | string | |
|
Revenue Schedule
|
data.revenue_schedule | string | |
|
Product Relations
|
data.product_relations | array of string | |
|
Primary Contact
|
data.primary_contact | string | |
|
Primary Contact
|
data.primary_account | string | |
|
Contact Relations
|
data.contact_relations | array of string | |
|
Account Relations
|
data.account_relations | array of string | |
|
Documents
|
data.documents | array of string | |
|
Quote Relations
|
data.quote_relations | array of string | |
|
Status
|
data.status | integer | |
|
Qualify Date
|
data.qualify_date | string | |
|
Won Date
|
data.won_date | string | |
|
Lost Date
|
data.lost_date | string | |
|
Days In Step
|
data.days_in_step | integer | |
|
Is Favorite
|
data.is_favorite | boolean | |
|
Sharing Units
|
data.sharing_units | array of string | |
|
Sharing Clients
|
data.sharing_clients | array of string | |
|
Tags
|
data.tags | array of string | |
|
Formatted Name
|
data.formatted_name | string | |
|
Modified by User
|
data.modified_by_user | string |
Get Task
Get task with given ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
Your Service URL starting with https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Task ID
|
id | True | string |
ID of the Task |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
Is Delete Protected
|
data.is_delete_protected | boolean | |
|
Task ID
|
data.id | string | |
|
Active Reminder
|
data.active_reminder | string | |
|
Is Deleted
|
data.is_deleted | boolean | |
|
Date Created
|
data.created | string | |
|
Date Modified
|
data.modified | string | |
|
Activity Type
|
data.activity_type | string | |
|
Call Outcome
|
data.call_outcome | string | |
|
Owner
|
data.owner | string | |
|
Unit
|
data.unit | string | |
|
Activity Type ID
|
data.activity_type_id | string | |
|
Call Duration
|
data.call_duration | integer | |
|
Call Outcome ID
|
data.call_outcome_id | string | |
|
Description
|
data.description | string | |
|
Due Date
|
data.due_date | string | |
|
Duration
|
data.duration | string | |
|
Owner ID
|
data.owner_id | string | |
|
Priority
|
data.priority | integer |
1 - Low, 2 - Medium, 3 - High |
|
Share Mode
|
data.share_mode | integer | |
|
Start Date
|
data.start_date | string | |
|
Status
|
data.status | integer |
1 - Not Started, 2 - In Progress, 3 - Waiting, 4 - Completed, 5 - Deferred |
|
Task Subject
|
data.subject | string | |
|
Table Name
|
data.table_name | string | |
|
Sales Unit ID
|
data.unit_id | string | |
|
Revision
|
data.revision | integer | |
|
Sharing Units
|
data.sharing_units | array of string | |
|
Sharing Clients
|
data.sharing_clients | array of string | |
|
Account Relations
|
data.account_relations | array of string | |
|
Contact Relations
|
data.contact_relations | array of string | |
|
Lead Relations
|
data.lead_relations | array of string | |
|
Opportunity Relations
|
data.opportunity_relations | array of string | |
|
Project Relations
|
data.project_relations | array of string | |
|
Quote Relations
|
data.quote_relations | array of string | |
|
Reminder
|
data.reminder | string | |
|
Task Recurrence
|
data.task_recurrence | string | |
|
Documents
|
data.documents | array of string | |
|
Comments
|
data.comments | array of string | |
|
Formatted Name
|
data.formatted_name | string | |
|
Modified By User
|
data.modified_by_user | string |
Update Account
Modifies account or accounts with given ID(s).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Account ID
|
id | True | string |
ID |
|
Account Name
|
name | string | ||
|
Owner ID
|
owner_id | string |
ID |
|
|
Account Type ID
|
account_type_id | string |
ID |
|
|
Sales Unit ID
|
unit_id | string |
ID |
|
|
Account Class
|
account_class | integer |
1 - No Class, 2 - Class A, 3 - Class B, 4 - Class C, 5 - Class D |
|
|
Primary E-mail
|
email1 | string |
E-mail address |
|
|
Primary Phone
|
phone1 | string |
Phone number |
|
|
Homepage
|
home_page | string |
URL |
|
|
Address
|
address | string | ||
|
City
|
city | string | ||
|
Country
|
country | string | ||
|
State / Province
|
state_province | string | ||
|
ZIP Code
|
zip_code | string | ||
|
Comments
|
comments | string |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
Is Delete Protected
|
data.is_delete_protected | boolean | |
|
Account ID
|
data.id | string | |
|
Is Deleted
|
data.is_deleted | boolean | |
|
Date Created
|
data.created | string | |
|
Date Modified
|
data.modified | string | |
|
Account Type
|
data.account_type | string | |
|
Customer Type
|
data.customer_type | string | |
|
Industry
|
data.industry | string | |
|
Owner
|
data.owner | string | |
|
Parent Account
|
data.parent_account | string | |
|
Parent Account Relation Type
|
data.parent_account_relation_type | string | |
|
Picture
|
data.picture | string | |
|
Unit
|
data.unit | string | |
|
Account Class
|
data.account_class | integer | |
|
Account Type ID
|
data.account_type_id | string | |
|
Address
|
data.address | string | |
|
City
|
data.city | string | |
|
Comments
|
data.comments | string | |
|
Country
|
data.country | string | |
|
Customer Type ID
|
data.customer_type_id | string | |
|
Primary E-mail
|
data.email1 | string | |
|
E-mail 2
|
data.email2 | string | |
|
E-mail 3
|
data.email3 | string | |
|
E-mail 4
|
data.email4 | string | |
|
E-mail 5
|
data.email5 | string | |
|
Health Category
|
data.health_category | string | |
|
Health Status
|
data.health_status | integer | |
|
Home Page
|
data.home_page | string | |
|
Industry ID
|
data.industry_id | string | |
|
Account Name
|
data.name | string | |
|
Owner ID
|
data.owner_id | string | |
|
Parent Account ID
|
data.parent_account_id | string | |
|
Parent Account Relation Type ID
|
data.parent_account_relation_type_id | string | |
|
Primary Phone
|
data.phone1 | string | |
|
Phone 2
|
data.phone2 | string | |
|
Phone 3
|
data.phone3 | string | |
|
Phone 4
|
data.phone4 | string | |
|
Phone 5
|
data.phone5 | string | |
|
Picture ID
|
data.picture_id | string | |
|
Quick Parent Account Name
|
data.quick_parent_account_name | string | |
|
Share Mode
|
data.share_mode | integer | |
|
State / Province
|
data.state_province | string | |
|
Sales Unit ID
|
data.unit_id | string | |
|
ZIP Code
|
data.zip_code | string | |
|
Revision
|
data.revision | integer | |
|
Formatted Name
|
data.formatted_name | string | |
|
Social Media
|
data.social_media | string | |
|
Sharing Units
|
data.sharing_units | array of string | |
|
Sharing Clients
|
data.sharing_clients | array of string | |
|
Documents
|
data.documents | array of string | |
|
Is Favorite
|
data.is_favorite | boolean | |
|
Is Unsubscribed
|
data.is_unsubscribed | boolean | |
|
Tags
|
data.tags | array of string | |
|
Modified By User
|
data.modified_by_user | string |
Update Contact
Modifies contact or contacts with given ID(s).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
Your Service URL starting with https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Contact ID
|
id | True | string |
ID |
|
Title / Salutation
|
title | string | ||
|
First Name
|
first_name | string | ||
|
Middle Name
|
middle_name | string | ||
|
Last Name
|
last_name | string | ||
|
Gender
|
gender | integer |
0 - Unknown, 1 - Male, 2 - Female, 3 - Non-binary |
|
|
Contact Type ID
|
contact_type_id | string |
ID |
|
|
Sales Unit ID
|
unit_id | string |
ID |
|
|
Owner ID
|
owner_id | string |
ID |
|
|
E-mail
|
email1 | string |
E-mail address |
|
|
Phone
|
phone1 | string |
Phone number |
|
|
Address
|
address | string | ||
|
City
|
city | string | ||
|
State / Province
|
state_province | string | ||
|
ZIP Code
|
zip_code | string | ||
|
Country
|
country | string | ||
|
Comments
|
comments | string |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
Is Delete Protected
|
data.is_delete_protected | boolean | |
|
Contact ID
|
data.id | string | |
|
Is Deleted
|
data.is_deleted | boolean | |
|
Date Modified
|
data.modified | string | |
|
Date Creted
|
data.created | string | |
|
Contact Type
|
data.contact_type | string | |
|
Owner
|
data.owner | string | |
|
Picture
|
data.picture | string | |
|
Unit
|
data.unit | string | |
|
Address
|
data.address | string | |
|
City
|
data.city | string | |
|
Comments
|
data.comments | string | |
|
Contact Type ID
|
data.contact_type_id | string | |
|
Country
|
data.country | string | |
|
Primary E-Mail
|
data.email1 | string | |
|
E-mail 2
|
data.email2 | string | |
|
E-mail 3
|
data.email3 | string | |
|
E-mail 4
|
data.email4 | string | |
|
E-mail 5
|
data.email5 | string | |
|
First Name
|
data.first_name | string | |
|
Last Name
|
data.last_name | string | |
|
Middle Name
|
data.middle_name | string | |
|
Gender
|
data.gender | integer |
0 - Unknown, 1 - Male, 2 - Female, 3 - Non-binary |
|
Owner ID
|
data.owner_id | string | |
|
Primary Phone
|
data.phone1 | string | |
|
Phone 2
|
data.phone2 | string | |
|
Phone 3
|
data.phone3 | string | |
|
Phone 4
|
data.phone4 | string | |
|
Phone 5
|
data.phone5 | string | |
|
Picture ID
|
data.picture_id | string | |
|
Position
|
data.position | string | |
|
Quick Account Name
|
data.quick_account_name | string | |
|
Share Mode
|
data.share_mode | integer | |
|
State / Province
|
data.state_province | string | |
|
Title
|
data.title | string | |
|
Unit ID
|
data.unit_id | string | |
|
ZIP Code
|
data.zip_code | string | |
|
Revision
|
data.revision | integer | |
|
Formatted Name
|
data.formatted_name | string | |
|
Social Media
|
data.social_media | string | |
|
Primary Account
|
data.primary_account | string | |
|
Account Relations
|
data.account_relations | array of string | |
|
Sharing Units
|
data.sharing_units | array of string | |
|
Sharing Clients
|
data.sharing_clients | array of string | |
|
Documents
|
data.documents | array of string | |
|
Is Favorite
|
data.is_favorite | boolean | |
|
Primary Account Roles
|
data.primary_account_account_roles | array of string | |
|
Primary Account Position
|
data.primary_account_position | string | |
|
Account Position
|
data.account_position | string | |
|
Is Unsubscribed
|
data.is_unsubscribed | boolean | |
|
Tags
|
data.tags | array of string | |
|
Primary Account Relationship
|
data.primary_account_relationship | integer | |
|
Modified By User
|
data.modified_by_user | string |
Update Lead
Modifies lead or leads with given ID(s).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
Your Service URL starting with https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Lead ID
|
id | True | string |
ID |
|
Creation Date
|
created | string | ||
|
Lead Name
|
name | string | ||
|
Description
|
description | string | ||
|
Ranking
|
ranking | integer |
Number between 1 and 100 |
|
|
Lead Type ID
|
lead_type_id | string |
ID |
|
|
Step ID
|
step_id | string |
ID |
|
|
Sales Unit ID
|
unit_id | string |
ID |
|
|
Owner ID
|
owner_id | string |
ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
Is Delete Protected
|
data.is_delete_protected | boolean | |
|
Lead ID
|
data.id | string | |
|
Is Deleted
|
data.is_deleted | boolean | |
|
Date Created
|
data.created | string | |
|
Date Modified
|
data.modified | string | |
|
Lead Type
|
data.lead_type | string | |
|
Owner
|
data.owner | string | |
|
Reason of Close
|
data.reason_of_close | string | |
|
Step
|
data.step | string | |
|
Unit
|
data.unit | string | |
|
Description
|
data.description | string | |
|
Is Archived
|
data.is_archived | boolean | |
|
Label Flag
|
data.label_flag | integer | |
|
Lead Type ID
|
data.lead_type_id | string | |
|
Lead Name
|
data.name | string | |
|
Owner ID
|
data.owner_id | string | |
|
Quick Account E-mail
|
data.quick_account_email | string | |
|
Quick Account Name
|
data.quick_account_name | string | |
|
Quick Account Phone
|
data.quick_account_phone | string | |
|
Quick Contact Name
|
data.quick_contact_name | string | |
|
Quick E-mail
|
data.quick_email | string | |
|
Quick Phone
|
data.quick_phone | string | |
|
Ranking
|
data.ranking | integer | |
|
Reason of Close Description
|
data.reason_of_close_description | string | |
|
Reason of Close ID
|
data.reason_of_close_id | string | |
|
Share Mode
|
data.share_mode | integer | |
|
Step ID
|
data.step_id | string | |
|
Table Name
|
data.table_name | string | |
|
Sales Unit ID
|
data.unit_id | string | |
|
Revision
|
data.revision | integer | |
|
Primary Contact
|
data.primary_contact | string | |
|
Primary Account
|
data.primary_account | string | |
|
Contact Relations
|
data.contact_relations | array of string | |
|
Account Relations
|
data.account_relations | array of string | |
|
Status
|
data.status | integer |
1 - Open, 2 - Lost, 4 - Qualified |
|
Sharing Units
|
data.sharing_units | array of string | |
|
Sharing Clients
|
data.sharing_clients | array of string | |
|
Documents
|
data.documents | array of string | |
|
Tags
|
data.tags | array of string | |
|
Qualify Date
|
data.qualify_date | string | |
|
Days In Step
|
data.days_in_step | integer | |
|
Is Favorite
|
data.is_favorite | boolean | |
|
Lost Date
|
data.lost_date | string | |
|
Formatted Name
|
data.formatted_name | string | |
|
Modified By User
|
data.modified_by_user | string |
Update Opportunity
Modifies opportunity or opportunities with given ID(s).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
Your Service URL starting with https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Opportunity ID
|
id | True | string |
ID of the Opportunity |
|
Creation Date
|
created | string | ||
|
Opportunity Name
|
name | string | ||
|
Opportunity Value
|
base_value | number | ||
|
Currency
|
currency_id | string | ||
|
Foreign Value
|
value_foreign | number | ||
|
Closing date
|
closing_date | date | ||
|
Description
|
description | string | ||
|
Ranking
|
ranking | integer |
Number between 1 and 100 |
|
|
Opportunity Type ID
|
oppty_type_id | string |
ID |
|
|
Step ID
|
step_id | string |
ID |
|
|
Sales Unit ID
|
unit_id | string |
ID |
|
|
Owner ID
|
owner_id | string |
ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
Is Delete Protected
|
data.is_delete_protected | boolean | |
|
Opportunity ID
|
data.id | string | |
|
Is Deleted
|
data.is_deleted | boolean | |
|
Date Created
|
data.created | string | |
|
Date Modified
|
data.modified | string | |
|
Active Quote
|
data.active_quote | string | |
|
Opportunity Type
|
data.oppty_type | string | |
|
Owner
|
data.owner | string | |
|
Product Currenct
|
data.product_currency | string | |
|
Product Price List
|
data.product_price_list | string | |
|
Reason of Close
|
data.reason_of_close | string | |
|
Step
|
data.step | string | |
|
Unit
|
data.unit | string | |
|
Active Quote ID
|
data.active_quote_id | string | |
|
Closing Date
|
data.closing_date | string | |
|
Description
|
data.description | string | |
|
Is Archived
|
data.is_archived | boolean | |
|
Is Value Auto Calculate
|
data.is_value_auto_calculate | boolean | |
|
Label Flags
|
data.label_flag | integer | |
|
Opportunity Name
|
data.name | string | |
|
Opportunity Type ID
|
data.oppty_type_id | string | |
|
Owner ID
|
data.owner_id | string | |
|
Product Currency ID
|
data.product_currency_id | string | |
|
Product Price List ID
|
data.product_price_list_id | string | |
|
Quick Account Email
|
data.quick_account_email | string | |
|
Quick Account Name
|
data.quick_account_name | string | |
|
Quick Account Phone
|
data.quick_account_phone | string | |
|
Quick Contact Name
|
data.quick_contact_name | string | |
|
Quick Email
|
data.quick_email | string | |
|
Quick Phone
|
data.quick_phone | string | |
|
Ranking
|
data.ranking | integer | |
|
Reason of Close Description
|
data.reason_of_close_description | string | |
|
Reason of Close ID
|
data.reason_of_close_id | string | |
|
Share Mode
|
data.share_mode | integer | |
|
Step ID
|
data.step_id | string | |
|
Table Name
|
data.table_name | string | |
|
Unit ID
|
data.unit_id | string | |
|
Was Qualified
|
data.was_qualified | boolean | |
|
Revision
|
data.revision | integer | |
|
Base Value
|
data.value.base_value | number | |
|
Currency ID
|
data.value.currency_id | string | |
|
Value Foreign
|
data.value.value_foreign | number | |
|
Opportunity Recurrence
|
data.oppty_recurrence | string | |
|
Revenue Schedule
|
data.revenue_schedule | string | |
|
Product Relations
|
data.product_relations | array of string | |
|
Primary Contact
|
data.primary_contact | string | |
|
Primary Contact
|
data.primary_account | string | |
|
Contact Relations
|
data.contact_relations | array of string | |
|
Account Relations
|
data.account_relations | array of string | |
|
Documents
|
data.documents | array of string | |
|
Quote Relations
|
data.quote_relations | array of string | |
|
Status
|
data.status | integer | |
|
Qualify Date
|
data.qualify_date | string | |
|
Won Date
|
data.won_date | string | |
|
Lost Date
|
data.lost_date | string | |
|
Days In Step
|
data.days_in_step | integer | |
|
Is Favorite
|
data.is_favorite | boolean | |
|
Sharing Units
|
data.sharing_units | array of string | |
|
Sharing Clients
|
data.sharing_clients | array of string | |
|
Tags
|
data.tags | array of string | |
|
Formatted Name
|
data.formatted_name | string | |
|
Modified by User
|
data.modified_by_user | string |
Update Task
Modifies task or tasks with given ID(s).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Service URL
|
service_url | True | string |
Your Service URL starting with https:// |
|
Space ID
|
space_id | True | string |
Your Space ID |
|
Task ID
|
id | True | string |
ID of the Task |
|
Subject
|
subject | string | ||
|
Task Type ID
|
activity_type_id | string |
ID |
|
|
Sales Unit ID
|
unit_id | string |
ID |
|
|
Owner ID
|
owner_id | string |
ID |
|
|
Description
|
description | string | ||
|
Due Date
|
due_date | date | ||
|
Priority
|
priority | integer |
1 - Low, 2 - Medium, 3 - High |
|
|
Status
|
status | integer |
1 - Not Started, 2 - In Progress, 3 - Waiting, 4 - Completed, 5 - Deferred |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
success | boolean | |
|
Is Delete Protected
|
data.is_delete_protected | boolean | |
|
Task ID
|
data.id | string | |
|
Active Reminder
|
data.active_reminder | string | |
|
Is Deleted
|
data.is_deleted | boolean | |
|
Date Created
|
data.created | string | |
|
Date Modified
|
data.modified | string | |
|
Activity Type
|
data.activity_type | string | |
|
Call Outcome
|
data.call_outcome | string | |
|
Owner
|
data.owner | string | |
|
Unit
|
data.unit | string | |
|
Activity Type ID
|
data.activity_type_id | string | |
|
Call Duration
|
data.call_duration | integer | |
|
Call Outcome ID
|
data.call_outcome_id | string | |
|
Description
|
data.description | string | |
|
Due Date
|
data.due_date | string | |
|
Duration
|
data.duration | string | |
|
Owner ID
|
data.owner_id | string | |
|
Priority
|
data.priority | integer |
1 - Low, 2 - Medium, 3 - High |
|
Share Mode
|
data.share_mode | integer | |
|
Start Date
|
data.start_date | string | |
|
Status
|
data.status | integer |
1 - Not Started, 2 - In Progress, 3 - Waiting, 4 - Completed, 5 - Deferred |
|
Task Subject
|
data.subject | string | |
|
Table Name
|
data.table_name | string | |
|
Sales Unit ID
|
data.unit_id | string | |
|
Revision
|
data.revision | integer | |
|
Sharing Units
|
data.sharing_units | array of string | |
|
Sharing Clients
|
data.sharing_clients | array of string | |
|
Account Relations
|
data.account_relations | array of string | |
|
Contact Relations
|
data.contact_relations | array of string | |
|
Lead Relations
|
data.lead_relations | array of string | |
|
Opportunity Relations
|
data.opportunity_relations | array of string | |
|
Project Relations
|
data.project_relations | array of string | |
|
Quote Relations
|
data.quote_relations | array of string | |
|
Reminder
|
data.reminder | string | |
|
Task Recurrence
|
data.task_recurrence | string | |
|
Documents
|
data.documents | array of string | |
|
Comments
|
data.comments | array of string | |
|
Formatted Name
|
data.formatted_name | string | |
|
Modified By User
|
data.modified_by_user | string |