Pipedrive Component
Manage leads, companies, activities, and more on the Pipedrive platform
Component key: pipedrive
Description
Pipedrive is a sales-focused customer relationship management tool. This component allows you to manage leads, companies, activities, and more.
Connections
OAuth 2.0
To connect to Pipedrive you will need to create a new sandbox account in their Developers Corner.
Once you have your sandbox account you will need to create a new app at https://app.pipedrive.com/developer-hub.
Select Create an App and then select a Public app.
Fill in the minimal required fields and be sure to include Prismatic's OAuth 2.0 Callback URL: https://oauth2.prismatic.io/callback
Update the Access scopes to give your app access to the necessary types of data. Reference https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations for information on what permissions your integraiton might need. Click "Save".
After saving the "OAuth & Access scopes" section will include the Client ID and Client Secret for your app.
You are now ready to create the OAuth 2.0 connection to Pipedrive within Prismatic:
- Enter the Client ID and Client Secret values into the same named fields.
Save your integration and you should now be able to connect and authenticate to Pipedrive.
Note that you will need to submit your Pipedrive app for review if you chose "Yes" on the "Intent to publish app" page during app creation.
Pipedrive Custom Redirect URIs
If you plan to make your Pipedrive app public, and publish it in the Pipedrive marketplace, Pipedrive has additional stipulations for how app installation occurs. Please reference https://pipedrive.readme.io/docs/app-installation-flows
When a user within Pipedrive selects your app and clicks "Install", Pipedrive requires that your Callback URL handle an auth code without a state
search parameter in the URL.
Outside of this flow, the state
variable in Prismatic is used to map an auth code to a config variable.
When a user clicks "Connect" in the Prismatic marketplace, they visit a Pipedrive consent screen and are redirected to https://oauth2.prismatic.io/callback?code=[SOME AUTH CODE]&state=SW5example
.
Prismatic then exchanges that auth code
for an access token, and saves that access token to the config variable with the SW5example
ID.
With the Pipedrive installation flow, you will need to supply an endpoint that captures and handles an auth code that potentially has no state
attached to it (yet).
At a high level, you will need to:
- Create a custom endpoint within your app that can receive
code
and optionalstate
search parameters. - Save the
code
off to secure temporary browser storage- If the user is a guest of your app, encourage them to sign up for your app.
- If the user is registered but not logged in, have them log in.
- If the user is logged in, continue.
- Now that you have a user authenticated in your app with a Pipedrive auth
code
, programmatically create a customer in Prismatic (if needed) and programmatically deploy an (unconfigured) instance to the customer (assuming they do not have an instance of your Pipedrive integration already). - Look up the unconfigured instance's connection config variable's ID. Make a
GET
request tohttps://oauth2.prismatic.io/callback?code=[SOME AUTH CODE]&state=SW5....
wherestate
represents the config variable's ID. This will start the auth code exchange process. - Invoke
prismatic.configureInstance()
with the unconfigured instance's ID to open a config wizard. The connection will be "active" from the previous step and the user will be able to continue through the config flow.
Note that Pipedrive only allows you one Callback URL, which must be your custom endpoint (above), and must match redirect_uri
in the authorization URL if a user initiates connection from the Prismatic marketplace.
So, you need to override the redirect_uri
in the authorize URL to your custom endpoint.
Open your config variable in the integration designer and edit the Authorize URL from https://oauth.pipedrive.com/oauth/authorize
to something like https://oauth.pipedrive.com/oauth/authorize?redirect_uri=https://example.com/your/callback/endpoint
.
Input | Default | Notes |
---|---|---|
Authorization URL string / Required authorizeUrl | https://oauth.pipedrive.com/oauth/authorize | Authorization URL |
Client ID string / Required clientId | Client identifier | |
Client Secret password / Required clientSecret | Client secret | |
Scopes string Hidden Field scopes | Space-delimited scopes | |
Token URL string / Required tokenUrl | https://oauth.pipedrive.com/oauth/token | Token URL |
Data Sources
Select Deal
Select a Deal from a dropdown menu. | key: selectDeal | type: picklist
Input | Notes |
---|---|
Connection connection / Required connectionInput |
Example Payload for Select Deal
{
"result": [
{
"key": "1",
"label": "Deal Title - open"
}
]
}
Select Organization
Select an Organization from a dropdown menu. | key: selectOrganization | type: picklist
Input | Notes |
---|---|
Connection connection / Required connectionInput |
Example Payload for Select Organization
{
"result": [
{
"key": "1",
"label": "Jhon Doe"
}
]
}
Select Person
Select a Person from a dropdown menu. | key: selectPerson | type: picklist
Input | Notes |
---|---|
Connection connection / Required connectionInput |
Example Payload for Select Person
{
"result": [
{
"key": "1",
"label": "Jhon Doe"
}
]
}
Actions
Add Call Log
Add a call log | key: addCallLog
Input | Notes |
---|---|
Activity ID string activityId | If specified, this activity will be converted into a call log, with the information provided |
Connection connection / Required connection | |
Deal ID string dealId | The ID of the deal this call is associated with |
Duration string duration | The duration of the call in seconds |
End Time string / Required endTime | The date and time of the end of the call in UTC |
From Phone Number string fromPhoneNumber | The number that made the call |
Note string note | The note for the call log in HTML format |
Org ID string orgId | The ID of the organization this call is associated with |
Outcome string / Required outcome | Describes the outcome of the call |
Person ID string personId | The ID of the person this call is associated with |
Start Time string / Required startTime | The date and time of the start of the call in UTC |
Subject string subject | The name of the activity this call is attached to |
To Phone Number string / Required toPhoneNumber | The number called |
User ID string userId | The ID of the owner of the call log |
Add Channel
Add a channel | key: addChannel
Input | Default | Notes | Example |
---|---|---|---|
Avatar Url string avatarUrl | The URL for an icon that represents your channel | ||
Connection connection / Required connection | |||
Name string / Required name | The name of the channel | My Channel | |
Provider Channel ID string / Required providerChannelId | The channel ID | ||
Provider Type string providerType | other | It controls the icons (like the icon next to the conversation) | |
Template Support boolean templateSupport | false | If true, enables templates logic on UI |
Add Deal
Add a deal | key: addDeal
Input | Notes |
---|---|
Add Time string addTime | The optional creation date & time of the deal in UTC |
Connection connection / Required connection | |
Currency string currency | The currency of the deal |
Expected Close Date string expectedCloseDate | The expected close date of the deal |
Lost Reason string lostReason | The optional message about why the deal was lost (to be used when status = lost) |
Org ID string orgId | The ID of an organization which this deal will be linked to |
Person ID string personId | The ID of a person which this deal will be linked to |
Pipeline ID string pipelineId | The ID of the pipeline this deal will be added to |
Probability string probability | The success probability percentage of the deal |
Stage ID string stageId | The ID of the stage this deal will be added to |
Status string status | open = Open, won = Won, lost = Lost, deleted = Deleted |
Title string / Required title | The title of the deal |
User ID string userId | The ID of the user which will be the owner of the created deal |
Value string value | The value of the deal |
Visible To string visibleTo | The visibility of the deal. See https://developers.pipedrive.com/docs/api/v1/Deals#addDeal. |
Add Deal Follower
Add a follower to a deal | key: addDealFollower
Input | Notes |
---|---|
Connection connection / Required connection | |
Deal ID string / Required id | The ID of the deal |
User ID string / Required userId | The ID of the user |
Add Deal Participant
Add a participant to a deal | key: addDealParticipant
Input | Notes |
---|---|
Connection connection / Required connection | |
Deal ID string / Required id | The ID of the deal |
Person ID string / Required personId | The ID of the person |
Add Deal Product
Add a product to the deal, eventually creating a new item called a deal-product | key: addDealProduct
Input | Default | Notes |
---|---|---|
Comments string comments | Any textual comment associated with this product-deal attachment | |
Connection connection / Required connection | ||
Discount Percentage string discountPercentage | 0 | The discount % |
Duration string duration | 1 | The duration of the product (when product durations are not enabled for the company or if omitted, defaults to 1) |
Enabled Flag string enabledFlag | Whether the product is enabled on the deal or not | |
Deal ID string / Required id | The ID of the deal | |
Item Price string itemPrice | The price at which this product will be added to the deal | |
Product Variation ID string productVariationId | The ID of the product variation to use | |
Quantity string quantity | Quantity – e | |
Tax string tax | 0 | The tax percentage |
Add File
Upload and add a new file to a deal, person, org, product, activity or lead | key: addFile
Input | Notes |
---|---|
Connection connection / Required connection | |
Entity ID string / Required entityId | The numerical ID of the deal, person, org, product or activity, or UUID of the lead to associate this file with. |
Entity Type string / Required entityType | The type of entity to attach the file to |
File data / Required file | The file to upload - either string contents or a binary file |
File Name string / Required fileName | The name of the file to upload |
Example Payload for Add File
{
"data": {
"success": true,
"data": {
"id": 123,
"user_id": 456,
"deal_id": 1,
"person_id": 789,
"org_id": 1,
"product_id": 1,
"activity_id": 1,
"lead_id": "adf21080-0e10-11eb-879b-05d71fb426ec",
"log_id": null,
"add_time": "2020-02-20 14:36:35",
"update_time": "2020-02-20 14:36:31",
"file_name": "IMG_8189_52233498214699de9579e7b304a81b157b2eb2137e8062.jpg",
"file_type": "img",
"file_size": 7801780,
"active_flag": true,
"inline_flag": false,
"remote_location": "googledocs",
"remote_id": "1mT6jshiv6537IirwOExXJuG1jdR4F0FQ",
"cid": "",
"s3_bucket": "",
"mail_message_id": "",
"mail_template_id": "",
"deal_name": "",
"person_name": "Person",
"org_name": "",
"product_name": "",
"lead_name": "Test lead name",
"url": "https://2a7f.pipedrive.com/v1/files/123/download",
"name": "IMG_8189.jpg",
"description": ""
}
}
}
Add Lead
Add a lead | key: addLead
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Expected Close Date string expectedCloseDate | The date of when the deal which will be created from the lead is expected to be closed | |
Label Ids string labelIds | The IDs of the lead labels which will be associated with the lead | |
Organization ID string organizationId | The ID of an organization which this lead will be linked to | |
Owner ID string ownerId | The ID of the user which will be the owner of the created lead | |
Person ID string personId | The ID of a person which this lead will be linked to | |
Title string / Required title | The name of the lead | |
Value string value | The potential value of the lead | |
Visible To string visibleTo | The visibility of the lead | |
Was Seen boolean wasSeen | false | A flag indicating whether the lead was seen by someone in the Pipedrive UI |
Add Lead Label
Add a lead label | key: addLeadLabel
Input | Notes |
---|---|
Color string / Required color | The color of the label |
Connection connection / Required connection | |
Name string / Required name | The name of the lead label |
Add Organization
Add an organization | key: addOrganization
Input | Notes |
---|---|
Add Time string addTime | The optional creation date & time of the organization in UTC |
Connection connection / Required connection | |
Name string name | The name of the organization |
Owner ID string ownerId | The ID of the user who will be marked as the owner of this organization |
Visible To string visibleTo | The visibility of the organization |
Add Organization Follower
Add a follower to an organization | key: addOrganizationFollower
Input | Notes |
---|---|
Connection connection / Required connection | |
Organization ID string / Required id | The ID of the organization |
User ID string / Required userId | The ID of the user |
Add Person
Add a person | key: addPerson
Input | Notes |
---|---|
Add Time string addTime | The optional creation date & time of the person in UTC |
Connection connection / Required connection | |
Email string email | List of email data related to the person |
Marketing Status string marketingStatus | If the person does not have a valid email address, then the marketing status is **not set** and "no_consent" is returned for the "marketing_status" value when the new person is created |
Name string name | The name of the person |
Org ID string orgId | The ID of the organization this person will belong to |
Owner ID string ownerId | The ID of the user who will be marked as the owner of this person |
Phone string phone | List of phone data related to the person |
Visible To string visibleTo | The visibility of the person |
Add Person Follower
Add a follower to a person | key: addPersonFollower
Input | Notes |
---|---|
Connection connection / Required connection | |
Person ID string / Required id | The ID of the person |
User ID string / Required userId | If supplied, only persons owned by the given user will be returned |
Add Pipeline
Add a new pipeline | key: addPipeline
Input | Notes |
---|---|
Active string active | Whether this pipeline will be made inactive (hidden) or active |
Connection connection / Required connection | |
Deal Probability string dealProbability | Whether deal probability is disabled or enabled for this pipeline |
Name string / Required name | The name of the pipeline |
Order Nr string orderNr | Defines the order of pipelines |
Add Product
Add a product | key: addProduct
Input | Default | Notes |
---|---|---|
Active Flag string activeFlag | 1 | Whether this product will be made active or not |
Code string code | The product code | |
Connection connection / Required connection | ||
Name string name | The name of the product | |
Owner ID string ownerId | The ID of the user who will be marked as the owner of this product | |
Prices string prices | An array of objects, each containing: "currency" (string), "price" (number), "cost" (number, optional), "overhead_cost" (number, optional) | |
Selectable string selectable | 1 | Whether this product can be selected in deals or not |
Tax string tax | 0 | The tax percentage |
Unit string unit | The unit in which this product is sold | |
Visible To string visibleTo | The visibility of the product |
Add Product Follower
Add a follower to a product | key: addProductFollower
Input | Notes |
---|---|
Connection connection / Required connection | |
Product ID string / Required id | The ID of the product |
User ID string / Required userId | The ID of the user |
Add Stage
Add a new stage | key: addStage
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Deal Probability string dealProbability | The success probability percentage of the deal | |
Name string / Required name | The name of the stage | |
Pipeline ID string / Required pipelineId | The ID of the pipeline to add stage to | |
Rotten Days string rottenDays | The number of days the deals not updated in this stage would become rotten | |
Rotten Flag boolean rottenFlag | false | Whether deals in this stage can become rotten |
Cancel Recurring Subscription
Cancel a recurring subscription | key: cancelRecurringSubscription
Input | Notes |
---|---|
Connection connection / Required connection | |
End Date string endDate | The subscription termination date |
Subscription ID string / Required id | The ID of the subscription |
Delete Activity
Delete an activity | key: deleteActivity
Input | Notes |
---|---|
Connection connection / Required connection | |
Activity ID string / Required id | The ID of the activity |
Delete Call Log
Delete a call log | key: deleteCallLog
Input | Notes | Example |
---|---|---|
Connection connection / Required connection | ||
Call Log ID string / Required id | The ID received when you create the call log | 3cde3b05035cae14dcfc172bd8000d08 |
Delete Channel
Delete a channel | key: deleteChannel
Input | Notes |
---|---|
Connection connection / Required connection | |
Id string / Required id | The ID of the channel provided by the integration |
Delete Conversation
Delete a conversation | key: deleteConversation
Input | Notes |
---|---|
Channel ID string / Required channelId | The ID of the channel provided by the integration |
Connection connection / Required connection | |
Conversation ID string / Required conversationId | The ID of the conversation provided by the integration |
Delete Deal
Delete a deal | key: deleteDeal
Input | Notes |
---|---|
Connection connection / Required connection | |
Deal ID string / Required id | The ID of the deal |
Delete Deal Field
Delete a deal field | key: deleteDealField
Input | Notes |
---|---|
Connection connection / Required connection | |
Deal Field ID string / Required id | The ID of the deal field |
Delete Deal Follower
Delete a follower from a deal | key: deleteDealFollower
Input | Notes |
---|---|
Connection connection / Required connection | |
Follower ID string / Required followerId | The ID of the follower |
Deal ID string / Required id | The ID of the deal |
Delete Deal Participant
Delete a participant from a deal | key: deleteDealParticipant
Input | Notes |
---|---|
Connection connection / Required connection | |
Deal Participant ID string / Required dealParticipantId | The ID of the participant of the deal |
Deal ID string / Required id | The ID of the deal |
Delete Deal Product
Delete an attached product from a deal | key: deleteDealProduct
Input | Notes |
---|---|
Connection connection / Required connection | |
Deal ID string / Required id | The ID of the deal |
Product Attachment ID string / Required productAttachmentId | The product attachment ID |
Delete File
Delete a file | key: deleteFile
Input | Notes |
---|---|
Connection connection / Required connection | |
File ID string / Required id | The ID of a file |
Example Payload for Delete File
{
"data": {
"success": true,
"data": {
"id": 123
}
}
}
Delete Lead
Delete a lead | key: deleteLead
Input | Notes |
---|---|
Connection connection / Required connection | |
Lead ID string / Required id | The ID of the lead |
Delete Lead Label
Delete a lead label | key: deleteLeadLabel
Input | Notes |
---|---|
Connection connection / Required connection | |
Lead Label ID string / Required id | The ID of the lead label |
Delete Mail Thread
Delete mail thread | key: deleteMailThread
Input | Notes |
---|---|
Connection connection / Required connection | |
Mail Thread ID string / Required id | The ID of the mail thread |
Delete Organization
Delete an organization | key: deleteOrganization
Input | Notes |
---|---|
Connection connection / Required connection | |
Organization ID string / Required id | The ID of the organization |
Delete Organization Follower
Delete a follower from an organization | key: deleteOrganizationFollower
Input | Notes |
---|---|
Connection connection / Required connection | |
Follower ID string / Required followerId | The ID of the follower |
Organization ID string / Required id | The ID of the organization |
Delete Person
Delete a person | key: deletePerson
Input | Notes |
---|---|
Connection connection / Required connection | |
Person ID string / Required id | The ID of the person |
Delete Person Field
Delete a person field | key: deletePersonField
Input | Notes |
---|---|
Connection connection / Required connection | |
Person Field ID string / Required id | The ID of the field |
Delete Person Follower
Delete a follower from a person | key: deletePersonFollower
Input | Notes |
---|---|
Connection connection / Required connection | |
Follower ID string / Required followerId | The ID of the follower |
Person ID string / Required id | The ID of the person |
Delete Person Picture
Delete person picture | key: deletePersonPicture
Input | Notes |
---|---|
Connection connection / Required connection | |
Person ID string / Required id | The ID of the person |
Delete Pipeline
Delete a pipeline | key: deletePipeline
Input | Notes |
---|---|
Connection connection / Required connection | |
Pipeline ID string / Required id | The ID of the pipeline |
Delete Product
Delete a product | key: deleteProduct
Input | Notes |
---|---|
Connection connection / Required connection | |
Product ID string / Required id | The ID of the product |
Delete Product Field
Delete a product field | key: deleteProductField
Input | Notes |
---|---|
Connection connection / Required connection | |
Product Field ID string / Required id | The ID of the product field |
Delete Product Follower
Delete a follower from a product | key: deleteProductFollower
Input | Notes |
---|---|
Connection connection / Required connection | |
Follower ID string / Required followerId | The ID of the relationship between the follower and the product |
Product ID string / Required id | The ID of the product |
Delete Stage
Delete a stage | key: deleteStage
Input | Notes |
---|---|
Connection connection / Required connection | |
Stage ID string / Required id | The ID of the stage |
Delete Subscription
Delete a subscription | key: deleteSubscription
Input | Notes |
---|---|
Connection connection / Required connection | |
Subscription ID string / Required id | The ID of the subscription |
Download File
Download one file | key: downloadFile
Input | Notes |
---|---|
Connection connection / Required connection | |
File ID string / Required id | The ID of a file |
Example Payload for Download File
{
"data": {
"type": "Buffer",
"data": [
72,
101,
108,
108,
111,
44,
32,
87,
111,
114,
108,
100
]
},
"contentType": "text/plain"
}
Find Subscription By Deal
Find subscription by deal | key: findSubscriptionByDeal
Input | Notes |
---|---|
Connection connection / Required connection | |
Deal ID string / Required dealId | The ID of the deal |
Find Users By Name
Find users by name | key: findUsersByName
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Search By Email string searchByEmail | 1 | When enabled, the term will only be matched against email addresses of users |
Term string / Required term | The search term to look for |
Get Activities
Get all activities assigned to a particular user | key: getActivities
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Done string done | Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both done and not done activities. | |
End Date string endDate | Use the activity due date where you wish to stop fetching activities from | |
Filter ID string filterId | The ID of the filter to use (will narrow down results if used together with "user_id" parameter) | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Start Date string startDate | Use the activity due date where you wish to begin fetching activities from | |
Type string type | The type of the activity, can be one type or multiple types separated by a comma | |
User ID string userId | The ID of the user whose activities will be fetched. If omitted, the user associated with the API token will be used. If 0, activities for all company users will be fetched based on the permission sets. |
Get Activity
Get details of an activity | key: getActivity
Input | Notes |
---|---|
Connection connection / Required connection | |
Activity ID string / Required id | The ID of the activity |
Get Activity Fields
Get all activity fields | key: getActivityFields
Input | Notes |
---|---|
Connection connection / Required connection |
Get Activity Types
Get all activity types | key: getActivityTypes
Input | Notes |
---|---|
Connection connection / Required connection |
Get Call Log
Get details of a call log | key: getCallLog
Input | Notes | Example |
---|---|---|
Connection connection / Required connection | ||
Call Log ID string / Required id | The ID received when you create the call log | 3cde3b05035cae14dcfc172bd8000d08 |
Get Company Addons
Get all add-ons for a single company | key: getCompanyAddons
Input | Notes |
---|---|
Connection connection / Required connection |
Get Currencies
Get all supported currencies | key: getCurrencies
Input | Notes |
---|---|
Connection connection / Required connection | |
Term string term | Optional search term that is searched for from currency's name and/or code |
Get Current User
Get current user data | key: getCurrentUser
Input | Notes |
---|---|
Connection connection / Required connection |
Get Deal
Get details of a deal | key: getDeal
Input | Notes |
---|---|
Connection connection / Required connection | |
Deal ID string / Required id | The ID of the deal |
Get Deal Activities
List activities associated with a deal | key: getDealActivities
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Done string done | Whether the activity is done or not | |
Exclude string exclude | A comma-separated string of activity IDs to exclude from result | |
Deal ID string / Required id | The ID of the deal | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get Deal Field
Get one deal field | key: getDealField
Input | Notes |
---|---|
Connection connection / Required connection | |
Deal Field ID string / Required id | The ID of the deal field |
Get Deal Fields
Get all deal fields | key: getDealFields
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get Deal Files
List files attached to a deal | key: getDealFiles
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Deal ID string / Required id | The ID of the deal | |
Include Deleted Files string includeDeletedFiles | When enabled, the list of files will also include deleted files | |
Limit string limit | Items shown per page | |
Sort string sort | The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC") | |
Start string start | 0 | Pagination start |
Get Deal Followers
List followers of a deal | key: getDealFollowers
Input | Notes |
---|---|
Connection connection / Required connection | |
Deal ID string / Required id | The ID of the deal |
Get Deal Mail Messages
List mail messages associated with a deal | key: getDealMailMessages
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Deal ID string / Required id | The ID of the deal | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get Deal Participants
List participants of a deal | key: getDealParticipants
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Deal ID string / Required id | The ID of the deal | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get Deal Persons
List all persons associated with a deal | key: getDealPersons
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Deal ID string / Required id | The ID of the deal | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get Deal Products
List products attached to a deal | key: getDealProducts
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Deal ID string / Required id | The ID of the deal | |
Include Product Data string includeProductData | Whether to fetch product data along with each attached product (1) or not (0, default) | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get Deal Users
List permitted users | key: getDealUsers
Input | Notes |
---|---|
Connection connection / Required connection | |
Deal ID string / Required id | The ID of the deal |
Get Deals
Get all deals | key: getDeals
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Fetch All boolean fetchAll | false | If set to true, all records will be fetched. If set to false, the provided pagination will be used. |
Filter ID string filterId | The ID of the filter to use | |
Limit string limit | Items shown per page | |
Owned By You string ownedByYou | When supplied, only deals owned by you are returned | |
Sort string sort | The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC") | |
Stage ID string stageId | If supplied, only deals within the given stage will be returned | |
Start string start | 0 | Pagination start |
Status string status | all_not_deleted | Only fetch deals with a specific status |
User ID string userId | If supplied, only deals matching the given user will be returned |
Example Payload for Get Deals
{
"data": {
"data": [
{
"id": 1,
"creator_user_id": {
"id": 18487521,
"name": "Developer",
"email": "dummy@test.dev",
"has_pic": 0,
"pic_hash": null,
"active_flag": true,
"value": 18487521
},
"user_id": {
"id": 18487521,
"name": "Developer",
"email": "dummy@test.dev",
"has_pic": 0,
"pic_hash": null,
"active_flag": true,
"value": 18487521
},
"person_id": {
"active_flag": true,
"name": "test person",
"email": [
{
"value": "",
"primary": true
}
],
"phone": [
{
"value": "",
"primary": true
}
],
"owner_id": 18487521,
"value": 3
},
"org_id": {
"name": "test",
"people_count": 2,
"owner_id": 18487521,
"address": null,
"active_flag": true,
"cc_email": "test-sandbox@pipedrivemail.com",
"label_ids": [],
"owner_name": "Developer",
"value": 2
},
"stage_id": 1,
"title": "test deal",
"value": 2,
"currency": "USD",
"add_time": "2024-09-27 14:25:27",
"update_time": "2024-09-27 14:25:28",
"stage_change_time": null,
"active": true,
"deleted": false,
"status": "open",
"probability": null,
"next_activity_date": null,
"next_activity_time": null,
"next_activity_id": null,
"last_activity_id": null,
"last_activity_date": null,
"lost_reason": null,
"visible_to": "3",
"close_time": null,
"pipeline_id": 1,
"won_time": null,
"first_won_time": null,
"lost_time": null,
"products_count": 0,
"files_count": 0,
"notes_count": 0,
"followers_count": 1,
"email_messages_count": 0,
"activities_count": 0,
"done_activities_count": 0,
"undone_activities_count": 0,
"participants_count": 1,
"expected_close_date": null,
"last_incoming_mail_time": null,
"last_outgoing_mail_time": null,
"label": null,
"local_won_date": null,
"local_lost_date": null,
"local_close_date": null,
"origin": "ManuallyCreated",
"origin_id": null,
"channel": null,
"channel_id": null,
"stage_order_nr": 0,
"person_name": "test person",
"org_name": "test",
"next_activity_subject": null,
"next_activity_type": null,
"next_activity_duration": null,
"next_activity_note": null,
"formatted_value": "$2",
"weighted_value": 2,
"formatted_weighted_value": "$2",
"weighted_value_currency": "USD",
"rotten_time": null,
"owner_name": "Developer",
"cc_email": "test-sandbox+deal1@pipedrivemail.com",
"org_hidden": false,
"person_hidden": false
},
{
"id": 2,
"creator_user_id": {
"id": 18487521,
"name": "Developer",
"email": "dummy@test.dev",
"has_pic": 0,
"pic_hash": null,
"active_flag": true,
"value": 18487521
},
"user_id": {
"id": 18487521,
"name": "Developer",
"email": "dummy@test.dev",
"has_pic": 0,
"pic_hash": null,
"active_flag": true,
"value": 18487521
},
"person_id": {
"active_flag": true,
"name": "awesome person",
"email": [
{
"value": "",
"primary": true
}
],
"phone": [
{
"value": "",
"primary": true
}
],
"owner_id": 18487521,
"value": 4
},
"org_id": {
"name": "test",
"people_count": 2,
"owner_id": 18487521,
"address": null,
"active_flag": true,
"cc_email": "test-sandbox@pipedrivemail.com",
"label_ids": [],
"owner_name": "Developer",
"value": 2
},
"stage_id": 4,
"title": "test deal 2",
"value": 3,
"currency": "USD",
"add_time": "2024-09-27 14:25:53",
"update_time": "2024-09-27 14:31:57",
"stage_change_time": "2024-09-27 14:31:45",
"active": false,
"deleted": false,
"status": "won",
"probability": null,
"next_activity_date": null,
"next_activity_time": null,
"next_activity_id": null,
"last_activity_id": null,
"last_activity_date": null,
"lost_reason": null,
"visible_to": "3",
"close_time": "2024-09-27 14:31:57",
"pipeline_id": 1,
"won_time": "2024-09-27 14:31:57",
"first_won_time": "2024-09-27 14:31:57",
"lost_time": null,
"products_count": 0,
"files_count": 0,
"notes_count": 0,
"followers_count": 1,
"email_messages_count": 0,
"activities_count": 0,
"done_activities_count": 0,
"undone_activities_count": 0,
"participants_count": 1,
"expected_close_date": null,
"last_incoming_mail_time": null,
"last_outgoing_mail_time": null,
"label": null,
"local_won_date": "2024-09-27",
"local_lost_date": null,
"local_close_date": "2024-09-27",
"origin": "ManuallyCreated",
"origin_id": null,
"channel": null,
"channel_id": null,
"stage_order_nr": 3,
"person_name": "awesome person",
"org_name": "test",
"next_activity_subject": null,
"next_activity_type": null,
"next_activity_duration": null,
"next_activity_note": null,
"formatted_value": "$3",
"weighted_value": 3,
"formatted_weighted_value": "$3",
"weighted_value_currency": "USD",
"rotten_time": null,
"owner_name": "Developer",
"cc_email": "test-sandbox+deal2@pipedrivemail.com",
"org_hidden": false,
"person_hidden": false
}
],
"additional_data": {
"pagination": {
"start": 0,
"limit": 500,
"more_items_in_collection": false,
"next_start": 0
}
}
}
}
Get Deals Summary
Get deals summary | key: getDealsSummary
Input | Notes |
---|---|
Connection connection / Required connection | |
Filter ID string filterId | user_id will not be considered |
Stage ID string stageId | Only deals within the given stage will be returned |
Status string status | Only fetch deals with a specific status |
User ID string userId | Only deals matching the given user will be returned |
Get Deals Timeline
Get deals timeline | key: getDealsTimeline
Input | Notes |
---|---|
Amount string / Required amount | The number of given intervals, starting from "start_date", to fetch |
Connection connection / Required connection | |
Exclude Deals string excludeDeals | Whether to exclude deals list (1) or not (0) |
Field Key string / Required fieldKey | The date field key which deals will be retrieved from |
Filter ID string filterId | If supplied, only deals matching the given filter will be returned |
Interval string / Required interval | The type of the interval |
Pipeline ID string pipelineId | If supplied, only deals matching the given pipeline will be returned |
Start Date string / Required startDate | The date when the first interval starts |
Totals Convert Currency string totalsConvertCurrency | The 3-letter currency code of any of the supported currencies |
User ID string userId | If supplied, only deals matching the given user will be returned |
Get File Metadata by ID
Get metadata about one file by ID | key: getFile
Input | Notes |
---|---|
Connection connection / Required connection | |
File ID string / Required id | The ID of a file |
Example Payload for Get File Metadata by ID
{
"data": {
"success": true,
"data": {
"id": 123,
"user_id": 456,
"deal_id": 1,
"person_id": 789,
"org_id": 1,
"product_id": 1,
"activity_id": 1,
"lead_id": "adf21080-0e10-11eb-879b-05d71fb426ec",
"log_id": null,
"add_time": "2020-02-20 14:36:35",
"update_time": "2020-02-20 14:57:33",
"file_name": "IMG_8189_52233498214699de9579e7b304a81b157b2eb2137e8062.jpg",
"file_type": "img",
"file_size": 7801780,
"active_flag": true,
"inline_flag": false,
"remote_location": "googledocs",
"remote_id": "1mT6jshiv6537IirwOExXJuG1jdR4F0FQ",
"cid": "",
"s3_bucket": "",
"mail_message_id": "",
"mail_template_id": "",
"deal_name": "",
"person_name": "Person",
"org_name": "",
"product_name": "",
"lead_name": "Test lead name",
"url": "https://2a7f.pipedrive.com/v1/files/123/download",
"name": "test file name",
"description": "test file description"
}
}
}
Get Filter
Get one filter | key: getFilter
Input | Notes |
---|---|
Connection connection / Required connection | |
Filter ID string / Required id | The ID of the filter |
Get Filters
Get all filters | key: getFilters
Input | Notes |
---|---|
Connection connection / Required connection | |
Type string type | The types of filters to fetch |
Get Lead
Get one lead | key: getLead
Input | Notes |
---|---|
Connection connection / Required connection | |
Lead ID string / Required id | The ID of the lead |
Get Lead Labels
Get all lead labels | key: getLeadLabels
Input | Notes |
---|---|
Connection connection / Required connection |
Get Lead Sources
Get all lead sources | key: getLeadSources
Input | Notes |
---|---|
Connection connection / Required connection |
Get Leads
Get all leads | key: getLeads
Input | Default | Notes | Example |
---|---|---|---|
Archived Status string archivedStatus | Filtering based on the archived status of a lead | ||
Connection connection / Required connection | |||
Filter ID string filterId | The ID of the filter to use | 1 | |
Limit string limit | Items shown per page | ||
Owner ID string ownerId | If supplied, only leads matching the given user will be returned | 1 | |
Sort string sort | The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC") | ||
Start string start | 0 | Pagination start |
Get Mail Message
Get one mail message | key: getMailMessage
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Id string / Required id | The ID of the mail message to fetch | |
Include Body string includeBody | 1 | Whether to include the full message body or not |
Get Mail Thread
Get one mail thread | key: getMailThread
Input | Notes |
---|---|
Connection connection / Required connection | |
Mail Thread ID string / Required id | The ID of the mail thread |
Get Mail Thread Messages
Get all mail messages of mail thread | key: getMailThreadMessages
Input | Notes |
---|---|
Connection connection / Required connection | |
Mail Thread ID string / Required id | The ID of the mail thread |
Get Mail Threads
Get mail threads | key: getMailThreads
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Folder string / Required folder | inbox | The type of folder to fetch |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get Note Fields
Get all note fields | key: getNoteFields
Input | Notes |
---|---|
Connection connection / Required connection |
Get Organization
Get details of an organization | key: getOrganization
Input | Notes |
---|---|
Connection connection / Required connection | |
Organization ID string / Required id | The ID of the organization |
Get Organization Activities
List activities associated with an organization | key: getOrganizationActivities
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Done string done | Whether the activity is done or not | |
Exclude string exclude | A comma-separated string of activity IDs to exclude from result | |
Organization ID string / Required id | The ID of the organization | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get Organization Deals
List deals associated with an organization | key: getOrganizationDeals
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Organization ID string / Required id | The ID of the organization | |
Limit string limit | Items shown per page | |
Only Primary Association string onlyPrimaryAssociation | If set, only deals that are directly associated to the organization are fetched | |
Sort string sort | The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC") | |
Start string start | 0 | Pagination start |
Status string status | all_not_deleted | Only fetch deals with a specific status |
Get Organization Files
List files attached to an organization | key: getOrganizationFiles
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Organization ID string / Required id | The ID of the organization | |
Include Deleted Files string includeDeletedFiles | When enabled, the list of files will also include deleted files | |
Limit string limit | Items shown per page | |
Sort string sort | The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC") | |
Start string start | 0 | Pagination start |
Get Organization Followers
List followers of an organization | key: getOrganizationFollowers
Input | Notes |
---|---|
Connection connection / Required connection | |
Organization ID string / Required id | The ID of the organization |
Get Organization Mail Messages
List mail messages associated with an organization | key: getOrganizationMailMessages
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Organization ID string / Required id | The ID of the organization | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get Organization Persons
List persons of an organization | key: getOrganizationPersons
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Organization ID string / Required id | The ID of the organization | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get Organization Updates
List updates about an organization | key: getOrganizationUpdates
Input | Default | Notes |
---|---|---|
All Changes string allChanges | Whether to show custom field updates or not | |
Connection connection / Required connection | ||
Organization ID string / Required id | The ID of the organization | |
Items string items | A comma-separated string for filtering out item specific updates | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get Organization Users
List permitted users | key: getOrganizationUsers
Input | Notes |
---|---|
Connection connection / Required connection | |
Organization ID string / Required id | The ID of the organization |
Get Organizations
Get all organizations | key: getOrganizations
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Fetch All boolean fetchAll | false | If set to true, all records will be fetched. If set to false, the provided pagination will be used. |
Filter ID string filterId | The ID of the filter to use | |
First Char string firstChar | If supplied, only organizations whose name starts with the specified letter will be returned (case insensitive) | |
Limit string limit | Items shown per page | |
Sort string sort | The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC") | |
Start string start | 0 | Pagination start |
User ID string userId | If supplied, only organizations owned by the given user will be returned |
Example Payload for Get Organizations
{
"data": {
"data": [
{
"id": 1,
"creator_user_id": {
"id": 18487521,
"name": "test Developer",
"email": "dev@test.io",
"has_pic": 0,
"pic_hash": null,
"active_flag": true,
"value": 18487521
},
"user_id": {
"id": 18487521,
"name": "test Developer",
"email": "dev@test.io",
"has_pic": 0,
"pic_hash": null,
"active_flag": true,
"value": 18487521
},
"person_id": {
"active_flag": true,
"name": "test person",
"email": [
{
"value": "",
"primary": true
}
],
"phone": [
{
"value": "",
"primary": true
}
],
"owner_id": 18487521,
"value": 3
},
"org_id": {
"name": "test",
"people_count": 2,
"owner_id": 18487521,
"address": null,
"active_flag": true,
"cc_email": "test-sandbox@pipedrivemail.com",
"label_ids": [],
"owner_name": "test Developer",
"value": 2
},
"stage_id": 1,
"title": "test deal",
"value": 2,
"currency": "USD",
"add_time": "2024-09-27 14:25:27",
"update_time": "2024-09-27 14:25:28",
"stage_change_time": null,
"active": true,
"deleted": false,
"status": "open",
"probability": null,
"next_activity_date": null,
"next_activity_time": null,
"next_activity_id": null,
"last_activity_id": null,
"last_activity_date": null,
"lost_reason": null,
"visible_to": "3",
"close_time": null,
"pipeline_id": 1,
"won_time": null,
"first_won_time": null,
"lost_time": null,
"products_count": 0,
"files_count": 0,
"notes_count": 0,
"followers_count": 1,
"email_messages_count": 0,
"activities_count": 0,
"done_activities_count": 0,
"undone_activities_count": 0,
"participants_count": 1,
"expected_close_date": null,
"last_incoming_mail_time": null,
"last_outgoing_mail_time": null,
"label": null,
"local_won_date": null,
"local_lost_date": null,
"local_close_date": null,
"origin": "ManuallyCreated",
"origin_id": null,
"channel": null,
"channel_id": null,
"stage_order_nr": 0,
"person_name": "test person",
"org_name": "test",
"next_activity_subject": null,
"next_activity_type": null,
"next_activity_duration": null,
"next_activity_note": null,
"formatted_value": "$2",
"weighted_value": 2,
"formatted_weighted_value": "$2",
"weighted_value_currency": "USD",
"rotten_time": null,
"owner_name": "test Developer",
"cc_email": "test-sandbox+deal1@pipedrivemail.com",
"org_hidden": false,
"person_hidden": false
},
{
"id": 2,
"creator_user_id": {
"id": 18487521,
"name": "test Developer",
"email": "dev@test.io",
"has_pic": 0,
"pic_hash": null,
"active_flag": true,
"value": 18487521
},
"user_id": {
"id": 18487521,
"name": "test Developer",
"email": "dev@test.io",
"has_pic": 0,
"pic_hash": null,
"active_flag": true,
"value": 18487521
},
"person_id": {
"active_flag": true,
"name": "awesome person",
"email": [
{
"value": "",
"primary": true
}
],
"phone": [
{
"value": "",
"primary": true
}
],
"owner_id": 18487521,
"value": 4
},
"org_id": {
"name": "test",
"people_count": 2,
"owner_id": 18487521,
"address": null,
"active_flag": true,
"cc_email": "test-sandbox@pipedrivemail.com",
"label_ids": [],
"owner_name": "test Developer",
"value": 2
},
"stage_id": 4,
"title": "test deal 2",
"value": 3,
"currency": "USD",
"add_time": "2024-09-27 14:25:53",
"update_time": "2024-09-27 14:31:57",
"stage_change_time": "2024-09-27 14:31:45",
"active": false,
"deleted": false,
"status": "won",
"probability": null,
"next_activity_date": null,
"next_activity_time": null,
"next_activity_id": null,
"last_activity_id": null,
"last_activity_date": null,
"lost_reason": null,
"visible_to": "3",
"close_time": "2024-09-27 14:31:57",
"pipeline_id": 1,
"won_time": "2024-09-27 14:31:57",
"first_won_time": "2024-09-27 14:31:57",
"lost_time": null,
"products_count": 0,
"files_count": 0,
"notes_count": 0,
"followers_count": 1,
"email_messages_count": 0,
"activities_count": 0,
"done_activities_count": 0,
"undone_activities_count": 0,
"participants_count": 1,
"expected_close_date": null,
"last_incoming_mail_time": null,
"last_outgoing_mail_time": null,
"label": null,
"local_won_date": "2024-09-27",
"local_lost_date": null,
"local_close_date": "2024-09-27",
"origin": "ManuallyCreated",
"origin_id": null,
"channel": null,
"channel_id": null,
"stage_order_nr": 3,
"person_name": "awesome person",
"org_name": "test",
"next_activity_subject": null,
"next_activity_type": null,
"next_activity_duration": null,
"next_activity_note": null,
"formatted_value": "$3",
"weighted_value": 3,
"formatted_weighted_value": "$3",
"weighted_value_currency": "USD",
"rotten_time": null,
"owner_name": "test Developer",
"cc_email": "test-sandbox+deal2@pipedrivemail.com",
"org_hidden": false,
"person_hidden": false
}
],
"additional_data": {
"pagination": {
"start": 0,
"limit": 500,
"more_items_in_collection": false,
"next_start": 0
}
}
}
}
Get Permission Set
Get one permission set | key: getPermissionSet
Input | Notes |
---|---|
Connection connection / Required connection | |
Permission Set ID string / Required id | The ID of the permission set |
Get Permission Set Assignments
List permission set assignments | key: getPermissionSetAssignments
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Permission Set ID string / Required id | The ID of the permission set | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get Permission Sets
Get all permission sets | key: getPermissionSets
Input | Notes |
---|---|
Connection connection / Required connection |
Get Person
Get details of a person | key: getPerson
Input | Notes |
---|---|
Connection connection / Required connection | |
Person ID string / Required id | The ID of the person |
Get Person Activities
List activities associated with a person | key: getPersonActivities
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Done string done | Whether the activity is done or not | |
Exclude string exclude | A comma-separated string of activity IDs to exclude from result | |
Person ID string / Required id | The ID of the person | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get Person Deals
List deals associated with a person | key: getPersonDeals
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Person ID string / Required id | The ID of the person | |
Limit string limit | Items shown per page | |
Sort string sort | The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC") | |
Start string start | 0 | Pagination start |
Status string status | all_not_deleted | Only fetch deals with a specific status |
Get Person Field
Get one person field | key: getPersonField
Input | Notes |
---|---|
Connection connection / Required connection | |
Person Field ID string / Required id | The ID of the field |
Get Person Field Details
Get details of a specific field for a person | key: getPersonFieldDetails
Input | Notes |
---|---|
Connection connection / Required connection | |
Field ID string / Required fieldId | The ID of the field to fetch details for a person |
Get Person Fields
Get all person fields | key: getPersonFields
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get Person Files
List files attached to a person | key: getPersonFiles
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Person ID string / Required id | The ID of the person | |
Include Deleted Files string includeDeletedFiles | When enabled, the list of files will also include deleted files | |
Limit string limit | Items shown per page | |
Sort string sort | The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC") | |
Start string start | 0 | Pagination start |
Get Person Followers
List followers of a person | key: getPersonFollowers
Input | Notes |
---|---|
Connection connection / Required connection | |
Person ID string / Required id | The ID of the person |
Get Person Mail Messages
List mail messages associated with a person | key: getPersonMailMessages
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Person ID string / Required id | The ID of the person | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get Person Products
List products associated with a person | key: getPersonProducts
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Person ID string / Required id | The ID of the person | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get Person Updates
List updates about a person | key: getPersonUpdates
Input | Default | Notes |
---|---|---|
All Changes string allChanges | Whether to show custom field updates or not | |
Connection connection / Required connection | ||
Person ID string / Required id | The ID of the person | |
Items string items | A comma-separated string for filtering out item specific updates | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get Person Users
List permitted users | key: getPersonUsers
Input | Notes |
---|---|
Connection connection / Required connection | |
Person ID string / Required id | The ID of the person |
Get Persons
Get all persons | key: getPersons
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Fetch All boolean fetchAll | false | If set to true, all records will be fetched. If set to false, the provided pagination will be used. |
Filter ID string filterId | The ID of the filter to use | |
First Char string firstChar | If supplied, only persons whose name starts with the specified letter will be returned (case insensitive) | |
Limit string limit | Items shown per page | |
Sort string sort | The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC") | |
Start string start | 0 | Pagination start |
User ID string userId | If supplied, only persons owned by the given user will be returned |
Example Payload for Get Persons
{
"data": {
"data": [
{
"id": 1,
"company_id": 12882925,
"owner_id": {
"id": 18487521,
"name": "Test Developer",
"email": "dev@test.dev",
"has_pic": 0,
"pic_hash": null,
"active_flag": true,
"value": 18487521
},
"org_id": {
"name": "Acme",
"people_count": 2,
"owner_id": 18487521,
"address": null,
"active_flag": true,
"cc_email": "test-sandbox@pipedrivemail.com",
"label_ids": [],
"owner_name": "Test Developer",
"value": 1
},
"name": "John",
"first_name": "John",
"last_name": null,
"open_deals_count": 0,
"related_open_deals_count": 0,
"closed_deals_count": 0,
"related_closed_deals_count": 0,
"participant_open_deals_count": 0,
"participant_closed_deals_count": 0,
"email_messages_count": 0,
"activities_count": 0,
"done_activities_count": 0,
"undone_activities_count": 0,
"files_count": 5,
"notes_count": 0,
"followers_count": 1,
"won_deals_count": 0,
"related_won_deals_count": 0,
"lost_deals_count": 0,
"related_lost_deals_count": 0,
"active_flag": true,
"phone": [
{
"value": "",
"primary": true
}
],
"email": [
{
"value": "",
"primary": true
}
],
"first_char": "t",
"update_time": "2023-08-14 22:49:23",
"delete_time": null,
"add_time": "2023-04-06 02:51:24",
"visible_to": "3",
"picture_id": null,
"next_activity_date": null,
"next_activity_time": null,
"next_activity_id": null,
"last_activity_id": null,
"last_activity_date": null,
"last_incoming_mail_time": null,
"last_outgoing_mail_time": null,
"label": null,
"label_ids": [],
"im": [
{
"value": "",
"primary": true
}
],
"postal_address": null,
"postal_address_lat": null,
"postal_address_long": null,
"postal_address_subpremise": null,
"postal_address_street_number": null,
"postal_address_route": null,
"postal_address_sublocality": null,
"postal_address_locality": null,
"postal_address_admin_area_level_1": null,
"postal_address_admin_area_level_2": null,
"postal_address_country": null,
"postal_address_postal_code": null,
"postal_address_formatted_address": null,
"notes": null,
"birthday": null,
"job_title": null,
"org_name": "Acme",
"owner_name": "Test Developer",
"primary_email": null,
"5f1513c3d8ba7f34c0164f3f909280c3fa0c592e": "15",
"3cf151d1c54a8c13329a97403054d6306fe4680c": "17",
"cc_email": "test-sandbox@pipedrivemail.com"
},
{
"id": 2,
"company_id": 12882925,
"owner_id": {
"id": 18487521,
"name": "Test Developer",
"email": "dev@test.dev",
"has_pic": 0,
"pic_hash": null,
"active_flag": true,
"value": 18487521
},
"org_id": {
"name": "Acme",
"people_count": 2,
"owner_id": 18487521,
"address": null,
"active_flag": true,
"cc_email": "test-sandbox@pipedrivemail.com",
"label_ids": [],
"owner_name": "Test Developer",
"value": 1
},
"name": "John",
"first_name": "John",
"last_name": null,
"open_deals_count": 0,
"related_open_deals_count": 0,
"closed_deals_count": 0,
"related_closed_deals_count": 0,
"participant_open_deals_count": 0,
"participant_closed_deals_count": 0,
"email_messages_count": 0,
"activities_count": 0,
"done_activities_count": 0,
"undone_activities_count": 0,
"files_count": 0,
"notes_count": 0,
"followers_count": 1,
"won_deals_count": 0,
"related_won_deals_count": 0,
"lost_deals_count": 0,
"related_lost_deals_count": 0,
"active_flag": true,
"phone": [
{
"value": "",
"primary": true
}
],
"email": [
{
"label": "work",
"value": "john.doe@example.com",
"primary": true
}
],
"first_char": "j",
"update_time": "2023-07-13 21:26:05",
"delete_time": null,
"add_time": "2023-07-13 20:47:38",
"visible_to": "3",
"picture_id": null,
"next_activity_date": null,
"next_activity_time": null,
"next_activity_id": null,
"last_activity_id": null,
"last_activity_date": null,
"last_incoming_mail_time": null,
"last_outgoing_mail_time": null,
"label": null,
"label_ids": [],
"im": [
{
"value": "",
"primary": true
}
],
"postal_address": null,
"postal_address_lat": null,
"postal_address_long": null,
"postal_address_subpremise": null,
"postal_address_street_number": null,
"postal_address_route": null,
"postal_address_sublocality": null,
"postal_address_locality": null,
"postal_address_admin_area_level_1": null,
"postal_address_admin_area_level_2": null,
"postal_address_country": null,
"postal_address_postal_code": null,
"postal_address_formatted_address": null,
"notes": null,
"birthday": null,
"job_title": null,
"org_name": "Acme",
"owner_name": "Test Developer",
"primary_email": "john.doe@example.com",
"5f1513c3d8ba7f34c0164f3f909280c3fa0c592e": "15",
"3cf151d1c54a8c13329a97403054d6306fe4680c": "19",
"cc_email": "test-sandbox@pipedrivemail.com"
},
{
"id": 3,
"company_id": 12882925,
"owner_id": {
"id": 18487521,
"name": "Test Developer",
"email": "dev@test.dev",
"has_pic": 0,
"pic_hash": null,
"active_flag": true,
"value": 18487521
},
"org_id": {
"name": "Test",
"people_count": 2,
"owner_id": 18487521,
"address": null,
"active_flag": true,
"cc_email": "test-sandbox@pipedrivemail.com",
"label_ids": [],
"owner_name": "Test Developer",
"value": 2
},
"name": "test person",
"first_name": "test",
"last_name": "person",
"open_deals_count": 1,
"related_open_deals_count": 0,
"closed_deals_count": 0,
"related_closed_deals_count": 0,
"participant_open_deals_count": 0,
"participant_closed_deals_count": 0,
"email_messages_count": 0,
"activities_count": 0,
"done_activities_count": 0,
"undone_activities_count": 0,
"files_count": 0,
"notes_count": 0,
"followers_count": 1,
"won_deals_count": 0,
"related_won_deals_count": 0,
"lost_deals_count": 0,
"related_lost_deals_count": 0,
"active_flag": true,
"phone": [
{
"value": "",
"primary": true
}
],
"email": [
{
"value": "",
"primary": true
}
],
"first_char": "t",
"update_time": "2024-09-27 14:25:28",
"delete_time": null,
"add_time": "2024-09-27 14:25:27",
"visible_to": "3",
"picture_id": null,
"next_activity_date": null,
"next_activity_time": null,
"next_activity_id": null,
"last_activity_id": null,
"last_activity_date": null,
"last_incoming_mail_time": null,
"last_outgoing_mail_time": null,
"label": null,
"label_ids": [],
"im": [
{
"value": "",
"primary": true
}
],
"postal_address": null,
"postal_address_lat": null,
"postal_address_long": null,
"postal_address_subpremise": null,
"postal_address_street_number": null,
"postal_address_route": null,
"postal_address_sublocality": null,
"postal_address_locality": null,
"postal_address_admin_area_level_1": null,
"postal_address_admin_area_level_2": null,
"postal_address_country": null,
"postal_address_postal_code": null,
"postal_address_formatted_address": null,
"notes": null,
"birthday": null,
"job_title": null,
"org_name": "Test",
"owner_name": "Test Developer",
"primary_email": null,
"5f1513c3d8ba7f34c0164f3f909280c3fa0c592e": null,
"3cf151d1c54a8c13329a97403054d6306fe4680c": null,
"cc_email": "test-sandbox@pipedrivemail.com"
},
{
"id": 4,
"company_id": 12882925,
"owner_id": {
"id": 18487521,
"name": "Test Developer",
"email": "dev@test.dev",
"has_pic": 0,
"pic_hash": null,
"active_flag": true,
"value": 18487521
},
"org_id": {
"name": "Test",
"people_count": 2,
"owner_id": 18487521,
"address": null,
"active_flag": true,
"cc_email": "test-sandbox@pipedrivemail.com",
"label_ids": [],
"owner_name": "Test Developer",
"value": 2
},
"name": "awesome person",
"first_name": "awesome",
"last_name": "person",
"open_deals_count": 1,
"related_open_deals_count": 0,
"closed_deals_count": 0,
"related_closed_deals_count": 0,
"participant_open_deals_count": 0,
"participant_closed_deals_count": 0,
"email_messages_count": 0,
"activities_count": 0,
"done_activities_count": 0,
"undone_activities_count": 0,
"files_count": 0,
"notes_count": 0,
"followers_count": 1,
"won_deals_count": 0,
"related_won_deals_count": 0,
"lost_deals_count": 0,
"related_lost_deals_count": 0,
"active_flag": true,
"phone": [
{
"value": "",
"primary": true
}
],
"email": [
{
"value": "",
"primary": true
}
],
"first_char": "a",
"update_time": "2024-09-27 14:25:53",
"delete_time": null,
"add_time": "2024-09-27 14:25:53",
"visible_to": "3",
"picture_id": null,
"next_activity_date": null,
"next_activity_time": null,
"next_activity_id": null,
"last_activity_id": null,
"last_activity_date": null,
"last_incoming_mail_time": null,
"last_outgoing_mail_time": null,
"label": null,
"label_ids": [],
"im": [
{
"value": "",
"primary": true
}
],
"postal_address": null,
"postal_address_lat": null,
"postal_address_long": null,
"postal_address_subpremise": null,
"postal_address_street_number": null,
"postal_address_route": null,
"postal_address_sublocality": null,
"postal_address_locality": null,
"postal_address_admin_area_level_1": null,
"postal_address_admin_area_level_2": null,
"postal_address_country": null,
"postal_address_postal_code": null,
"postal_address_formatted_address": null,
"notes": null,
"birthday": null,
"job_title": null,
"org_name": "Test",
"owner_name": "Test Developer",
"primary_email": null,
"5f1513c3d8ba7f34c0164f3f909280c3fa0c592e": null,
"3cf151d1c54a8c13329a97403054d6306fe4680c": null,
"cc_email": "test-sandbox@pipedrivemail.com"
}
],
"additional_data": {
"pagination": {
"start": 0,
"limit": 500,
"more_items_in_collection": false,
"next_start": 0
}
}
}
}
Get Pipeline
Get one pipeline | key: getPipeline
Input | Notes |
---|---|
Connection connection / Required connection | |
Pipeline ID string / Required id | The ID of the pipeline |
Totals Convert Currency string totalsConvertCurrency | The 3-letter currency code of any of the supported currencies |
Get Pipeline Conversion Statistics
Get deals conversion rates in pipeline | key: getPipelineConversionStatistics
Input | Notes |
---|---|
Connection connection / Required connection | |
End Date string / Required endDate | The end of the period |
Pipeline ID string / Required id | The ID of the pipeline |
Start Date string / Required startDate | The start of the period |
User ID string userId | The ID of the user who"s pipeline metrics statistics to fetch |
Get Pipeline Deals
Get deals in a pipeline | key: getPipelineDeals
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Everyone string everyone | If supplied, "filter_id" and "user_id" will not be considered – instead, deals owned by everyone will be returned | |
Filter ID string filterId | If supplied, only deals matching the given filter will be returned | |
Get Summary string getSummary | Whether to include a summary of the pipeline in the "additional_data" or not | |
Pipeline ID string / Required id | The ID of the pipeline | |
Limit string limit | Items shown per page | |
Stage ID string stageId | If supplied, only deals within the given stage will be returned | |
Start string start | 0 | Pagination start |
Totals Convert Currency string totalsConvertCurrency | The 3-letter currency code of any of the supported currencies | |
User ID string userId | If supplied, "filter_id" will not be considered and only deals owned by the given user will be returned |
Get Pipeline Movement Statistics
Get deals movements in pipeline | key: getPipelineMovementStatistics
Input | Notes |
---|---|
Connection connection / Required connection | |
End Date string / Required endDate | The end of the period |
Pipeline ID string / Required id | The ID of the pipeline |
Start Date string / Required startDate | The start of the period |
User ID string userId | The ID of the user who"s pipeline statistics to fetch |
Get Pipelines
Get all pipelines | key: getPipelines
Input | Notes |
---|---|
Connection connection / Required connection |
Get Product
Get one product | key: getProduct
Input | Notes |
---|---|
Connection connection / Required connection | |
Product ID string / Required id | The ID of the product |
Get Product Deals
Get deals where a product is attached to | key: getProductDeals
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Product ID string / Required id | The ID of the product | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Status string status | all_not_deleted | Only fetch deals with a specific status |
Get Product Field
Get one product field | key: getProductField
Input | Notes |
---|---|
Connection connection / Required connection | |
Product Field ID string / Required id | The ID of the product field |
Get Product Fields
Get all product fields | key: getProductFields
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get Product Files
List files attached to a product | key: getProductFiles
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Product ID string / Required id | The ID of the product | |
Include Deleted Files string includeDeletedFiles | When enabled, the list of files will also include deleted files | |
Limit string limit | Items shown per page | |
Sort string sort | The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC") | |
Start string start | 0 | Pagination start |
Get Product Followers
List followers of a product | key: getProductFollowers
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Product ID string / Required id | The ID of the product | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get Product Users
List permitted users | key: getProductUsers
Input | Notes |
---|---|
Connection connection / Required connection | |
Product ID string / Required id | The ID of the product |
Get Products
Get all products | key: getProducts
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Filter ID string filterId | The ID of the filter to use | |
First Char string firstChar | If supplied, only products whose name starts with the specified letter will be returned (case insensitive) | |
Get Summary boolean getSummary | false | If supplied, the response will return the total numbers of products in the "additional_data |
Ids string ids | An array of integers with the IDs of the products that should be returned in the response | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
User ID string userId | If supplied, only products owned by the given user will be returned |
Get Stage
Get one stage | key: getStage
Input | Notes |
---|---|
Connection connection / Required connection | |
Everyone string everyone | If "everyone=1" is provided, deals summary will return deals owned by every user |
Stage ID string / Required id | The ID of the stage |
Get Stage Deals
Get deals in a stage | key: getStageDeals
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Everyone string everyone | If supplied, "filter_id" and "user_id" will not be considered – instead, deals owned by everyone will be returned | |
Filter ID string filterId | If supplied, only deals matching the given filter will be returned | |
Stage ID string / Required id | The ID of the stage | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
User ID string userId | If supplied, "filter_id" will not be considered and only deals owned by the given user will be returned |
Get Stages
Get all stages | key: getStages
Input | Notes |
---|---|
Connection connection / Required connection | |
Pipeline ID string pipelineId | The ID of the pipeline to fetch stages for |
Get Subscription
Get details of a subscription | key: getSubscription
Input | Notes |
---|---|
Connection connection / Required connection | |
Subscription ID string / Required id | The ID of the subscription |
Get Subscription Payments
Get all payments of a subscription | key: getSubscriptionPayments
Input | Notes |
---|---|
Connection connection / Required connection | |
Subscription ID string / Required id | The ID of the subscription |
Get User
Get one user by ID | key: getUser
Input | Notes |
---|---|
Connection connection / Required connection | |
User ID string / Required id | The ID of the user |
Get User Call Logs
Get all call logs assigned to a particular user | key: getUserCallLogs
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get User Connections
Get all user connections | key: getUserConnections
Input | Notes |
---|---|
Connection connection / Required connection |
Get User Followers
List followers of a user | key: getUserFollowers
Input | Notes |
---|---|
Connection connection / Required connection | |
User ID string / Required id | The ID of the user |
Get User Permissions
List user permissions | key: getUserPermissions
Input | Notes |
---|---|
Connection connection / Required connection | |
User ID string / Required id | The ID of the user |
Get User Role Assignments
List role assignments | key: getUserRoleAssignments
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
User ID string / Required id | The ID of the user | |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Get User Role Settings
List user role settings | key: getUserRoleSettings
Input | Notes |
---|---|
Connection connection / Required connection | |
User ID string / Required id | The ID of the user |
Get User Settings
List settings of an authorized user | key: getUserSettings
Input | Notes |
---|---|
Connection connection / Required connection |
Get Users
Get all users | key: getUsers
Input | Notes |
---|---|
Connection connection / Required connection |
List Files
List all files attached to all entities | key: getFiles
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Example Payload for List Files
{
"data": {
"success": true,
"data": [
{
"id": 123,
"user_id": 456,
"deal_id": 1,
"person_id": 789,
"org_id": 1,
"product_id": 1,
"activity_id": 1,
"lead_id": "adf21080-0e10-11eb-879b-05d71fb426ec",
"log_id": null,
"add_time": "2020-02-20 14:36:35",
"update_time": "2020-02-20 14:57:33",
"file_name": "IMG_8189_52233498214699de9579e7b304a81b157b2eb2137e8062.jpg",
"file_type": "img",
"file_size": 7801780,
"active_flag": true,
"inline_flag": false,
"remote_location": "googledocs",
"remote_id": "1mT6jshiv6537IirwOExXJuG1jdR4F0FQ",
"cid": "",
"s3_bucket": "",
"mail_message_id": "",
"mail_template_id": "",
"deal_name": "",
"person_name": "Person",
"lead_name": "Test lead name",
"org_name": "",
"product_name": "",
"url": "https://2a7f.pipedrive.com/v1/files/123/download",
"name": "test file name",
"description": "test file description"
}
],
"additional_data": {
"pagination": {
"start": 0,
"limit": 100,
"more_items_in_collection": true,
"next_start": 100
}
}
}
}
Merge Deals
Merge two deals | key: mergeDeals
Input | Notes |
---|---|
Connection connection / Required connection | |
Deal ID string / Required id | The ID of the deal |
Merge With ID string / Required mergeWithId | The ID of the deal that the deal will be merged with |
Merge Organizations
Merge two organizations | key: mergeOrganizations
Input | Notes |
---|---|
Connection connection / Required connection | |
Organization ID string / Required id | The ID of the organization |
Merge With ID string / Required mergeWithId | The ID of the organization that the organization will be merged with |
Merge Persons
Merge two persons | key: mergePersons
Input | Notes |
---|---|
Connection connection / Required connection | |
Person ID string / Required id | The ID of the person |
Merge With ID string / Required mergeWithId | The ID of the person that will not be overwritten |
Raw Request
Send raw HTTP request to Pipedrive | key: rawRequest
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Data string data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
File Data string Key Value List fileData | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] | |
File Data File Names string Key Value List fileDataFileNames | File names to apply to the file data inputs. Keys must match the file data keys above. | ||
Form Data string Key Value List formData | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] | |
Header string Key Value List headers | A list of headers to send with the request. | User-Agent: curl/7.64.1 | |
Max Retry Count string maxRetries | 0 | The maximum number of retries to attempt. Specify 0 for no retries. | |
Method string / Required method | The HTTP method to use. | ||
Query Parameter string Key Value List queryParams | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | ||
Response Type string / Required responseType | json | The type of data you expect in the response. You can request json, text, or binary data. | |
Retry On All Errors boolean retryAllErrors | false | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | |
Retry Delay (ms) string retryDelayMS | 0 | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | |
Timeout string timeout | The maximum time that a client will await a response to its request | 2000 | |
URL string / Required url | Input the path only (/files), The base URL is already included (https://api.pipedrive.com/). For example, to connect to https://api.pipedrive.com//files, only /files is entered in this field. | /files | |
Use Exponential Backoff boolean useExponentialBackoff | false | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. |
Search Deals
Search deals | key: searchDeals
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Exact Match boolean exactMatch | false | When enabled, only full exact matches against the given term are returned |
Fields string fields | custom_fields,notes,title | A comma-separated string array |
Include Fields string includeFields | Supports including optional fields in the results which are not provided by default | |
Limit string limit | Items shown per page | |
Organization ID string organizationId | Will filter deals by the provided organization ID | |
Person ID string personId | Will filter deals by the provided person ID | |
Start string start | 0 | Pagination start |
Status string status | Will filter deals by the provided specific status | |
Term string / Required term | The search term to look for |
Search Leads
Search leads | key: searchLeads
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Exact Match boolean exactMatch | false | When enabled, only full exact matches against the given term are returned |
Fields string fields | A comma-separated string array | |
Include Fields string includeFields | Supports including optional fields in the results which are not provided by default | |
Limit string limit | Items shown per page | |
Organization ID string organizationId | Will filter leads by the provided organization ID | |
Person ID string personId | Will filter leads by the provided person ID | |
Start string start | 0 | Pagination start |
Term string / Required term | The search term to look for |
Search Organization
Search organizations | key: searchOrganization
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Exact Match boolean exactMatch | false | When enabled, only full exact matches against the given term are returned |
Fields string fields | address,custom_fields,notes,name | A comma-separated string array |
Limit string limit | Items shown per page | |
Start string start | 0 | Pagination start |
Term string / Required term | The search term to look for |
Search Persons
Search persons | key: searchPersons
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Exact Match boolean exactMatch | false | When enabled, only full exact matches against the given term are returned |
Fields string fields | custom_fields,email,notes,phone,name | A comma-separated string array |
Include Fields string includeFields | Supports including optional fields in the results which are not provided by default | |
Limit string limit | Items shown per page | |
Organization ID string organizationId | Will filter persons by the provided organization ID | |
Start string start | 0 | Pagination start |
Term string / Required term | The search term to look for |
Set Person Field Value
Set the value of a specific field for a person | key: setFieldValueForPerson
Input | Notes |
---|---|
Connection connection / Required connection | |
Field Key string / Required customFieldKey | The key of the field to set |
Person ID string / Required personId | The ID of the person to set the field value for |
Value string / Required value | The new value for the field |
Update Deal
Update a deal | key: updateDeal
Input | Notes |
---|---|
Connection connection / Required connection | |
Currency string currency | The currency of the deal |
Expected Close Date string expectedCloseDate | The expected close date of the deal |
Deal ID string / Required id | The ID of the deal |
Lost Reason string lostReason | The optional message about why the deal was lost (to be used when status = lost) |
Org ID string orgId | The ID of an organization which this deal will be linked to |
Person ID string personId | The ID of a person which this deal will be linked to |
Pipeline ID string pipelineId | The ID of the pipeline this deal will be added to |
Probability string probability | The success probability percentage of the deal |
Stage ID string stageId | The ID of the stage this deal will be added to |
Status string status | open = Open, won = Won, lost = Lost, deleted = Deleted |
Title string title | The title of the deal |
User ID string userId | The ID of the user which will be the owner of the created deal |
Value string value | The value of the deal |
Visible To string visibleTo | The visibility of the deal |
Update Deal Product
Update product attachment details of the deal-product (a product already attached to a deal) | key: updateDealProduct
Input | Default | Notes |
---|---|---|
Comments string comments | Any textual comment associated with this product-deal attachment | |
Connection connection / Required connection | ||
Discount Percentage string discountPercentage | 0 | The discount % |
Duration string duration | 1 | The duration of the product (when product durations are not enabled for the company or if omitted, defaults to 1) |
Enabled Flag string enabledFlag | Whether the product is enabled on the deal or not | |
Deal ID string / Required id | The ID of the deal | |
Item Price string / Required itemPrice | The price at which this product will be added to the deal | |
Product Attachment ID string / Required productAttachmentId | The ID of the deal-product (the ID of the product attached to the deal) | |
Product Variation ID string productVariationId | The ID of the product variation to use | |
Quantity string / Required quantity | Quantity – e | |
Tax string tax | 0 | The tax percentage |
Update File
Update file name or description | key: updateFile
Input | Notes |
---|---|
Connection connection / Required connection | |
Description string description | |
File ID string / Required id | The ID of a file |
File Name string name |
Example Payload for Update File
{
"data": {
"success": true,
"data": {
"id": 123,
"user_id": 456,
"deal_id": 1,
"person_id": 789,
"org_id": 1,
"product_id": 1,
"activity_id": 1,
"lead_id": "adf21080-0e10-11eb-879b-05d71fb426ec",
"log_id": null,
"add_time": "2020-02-20 14:36:35",
"update_time": "2020-02-20 14:57:33",
"file_name": "IMG_8189_52233498214699de9579e7b304a81b157b2eb2137e8062.jpg",
"file_type": "img",
"file_size": 7801780,
"active_flag": true,
"inline_flag": false,
"remote_location": "googledocs",
"remote_id": "1mT6jshiv6537IirwOExXJuG1jdR4F0FQ",
"cid": "",
"s3_bucket": "",
"mail_message_id": ""