Skip to main content

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.

Pipedrive 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 access the Marketplace Manager under Tools and integrations in the menu under your avatar. Click "Create new app" and select either option under "Intent to publish app". Click "Next".

Fill in the minimal required fields (for private or unlisted you do not need to fill in the majority of 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. 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.

InputDefaultNotes
Input
Authorization URL
string
/ Required
Hidden Field
Default
https://oauth.pipedrive.com/oauth/authorize
Notes
Authorization URL
Input
Client ID
string
/ Required
Default
Notes
Client identifier
Input
Client Secret
password
/ Required
Default
Notes
Client secret
Input
Scopes
string
Hidden Field
Default
Notes
Space-delimited scopes
Input
Token URL
string
/ Required
Hidden Field
Default
https://oauth.pipedrive.com/oauth/token
Notes
Token URL

Actions#

Add Activity#

Add an activity | key: addActivity

InputDefaultNotes
Input
Attendees
string
Default
Notes
The attendees of the activity
Input
Busy Flag
boolean
Default
false
Notes
Set the activity as "Busy" or "Free"
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Deal Id
string
Default
Notes
The ID of the deal this activity is associated with
Input
Done
string
Default
Notes
Whether the activity is done or not
Input
Due Date
string
Default
Notes
The due date of the activity
Input
Due Time
string
Default
Notes
The due time of the activity in UTC
Input
Duration
string
Default
Notes
The duration of the activity
Input
Lead Id
string
Default
Notes
The ID of the lead this activity is associated with
Input
Location
string
Default
Notes
The address of the activity
Input
Note
string
Default
Notes
The note of the activity (HTML format)
Input
Org Id
string
Default
Notes
The ID of the organization this activity is associated with
Input
Participants
string
Default
Notes
List of multiple persons (participants) this activity is associated with
Input
Person Id
string
Default
Notes
The ID of the person this activity is associated with
Input
Public Description
string
Default
Notes
Additional details about the activity that is synced to your external calendar
Input
Subject
string
Default
Notes
The subject of the activity
Input
Type
string
Default
Notes
The type of the activity
Input
User Id
string
Default
Notes
The ID of the user whom the activity is assigned to

Add Activity Type#

Add new activity type | key: addActivityType

InputNotes
Input
Connection
connection
/ Required
Notes
 

Add Call Log#

Add a call log | key: addCallLog

InputNotes
Input
Activity Id
string
Notes
If specified, this activity will be converted into a call log, with the information provided
Input
Connection
connection
/ Required
Notes
 
Input
Deal Id
string
Notes
The ID of the deal this call is associated with
Input
Duration
string
Notes
The duration of the call in seconds
Input
End Time
string
/ Required
Notes
The date and time of the end of the call in UTC
Input
From Phone Number
string
Notes
The number that made the call
Input
Note
string
Notes
The note for the call log in HTML format
Input
Org Id
string
Notes
The ID of the organization this call is associated with
Input
Outcome
string
/ Required
Notes
Describes the outcome of the call
Input
Person Id
string
Notes
The ID of the person this call is associated with
Input
Start Time
string
/ Required
Notes
The date and time of the start of the call in UTC
Input
Subject
string
Notes
The name of the activity this call is attached to
Input
To Phone Number
string
/ Required
Notes
The number called
Input
User Id
string
Notes
The ID of the owner of the call log

Add Call Log Audio File#

Attach an audio file to the call log | key: addCallLogAudioFile

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Id
string
/ Required
Notes
The ID received when you create the call log
Example
3cde3b05035cae14dcfc172bd8000d08

Add Channel#

Add a channel | key: addChannel

InputDefaultNotesExample
Input
Avatar Url
string
Default
Notes
The URL for an icon that represents your channel
Example
 
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Name
string
/ Required
Default
Notes
The name of the channel
Example
My Channel
Input
Provider Channel Id
string
/ Required
Default
Notes
The channel ID
Example
 
Input
Provider Type
string
Default
other
Notes
It controls the icons (like the icon next to the conversation)
Example
 
Input
Template Support
boolean
Default
false
Notes
If true, enables templates logic on UI
Example
 

Add Deal#

Add a deal | key: addDeal

InputNotes
Input
Add Time
string
Notes
The optional creation date & time of the deal in UTC
Input
Connection
connection
/ Required
Notes
 
Input
Currency
string
Notes
The currency of the deal
Input
Expected Close Date
string
Notes
The expected close date of the deal
Input
Lost Reason
string
Notes
The optional message about why the deal was lost (to be used when status = lost)
Input
Org Id
string
Notes
The ID of an organization which this deal will be linked to
Input
Person Id
string
Notes
The ID of a person which this deal will be linked to
Input
Pipeline Id
string
Notes
The ID of the pipeline this deal will be added to
Input
Probability
string
Notes
The success probability percentage of the deal
Input
Stage Id
string
Notes
The ID of the stage this deal will be added to
Input
Status
string
Notes
open = Open, won = Won, lost = Lost, deleted = Deleted
Input
Title
string
Notes
The title of the deal
Input
User Id
string
Notes
The ID of the user which will be the owner of the created deal
Input
Value
string
Notes
The value of the deal
Input
Visible To
string
Notes
The visibility of the deal

Add Deal Field#

Add a new deal field | key: addDealField

InputDefaultNotes
Input
Add Visible Flag
boolean
Default
true
Notes
Whether the field is available in the "add new" modal or not (both in the web and mobile app)
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Field Type
string
Default
Notes
The type of the fieldValueDescription"address"Address field (has multiple subfields, autocompleted by Google Maps)"date"Date (format YYYY-MM-DD)"daterange"Date-range field (has a start date and end date value, both YYYY-MM-DD)"double"Numeric value"enum"Options field with a single possible chosen option"monetary"Monetary field (has a numeric value and a currency value)"org"Organization field (contains an organization ID which is stored on the same account)"people"Person field (contains a person ID which is stored on the same account)"phone"Phone field (up to 255 numbers and/or characters)"set"Options field with a possibility of having multiple chosen options"text"Long text (up to 65k characters)"time"Time field (format HH:MM:SS)"timerange"Time-range field (has a start time and end time value, both HH:MM:SS)"user"User field (contains a user ID of another Pipedrive user)"varchar"Text (up to 255 characters)"varchar_auto"Autocomplete text (up to 255 characters)"visible_to"System field that keeps item"s visibility setting
Input
Name
string
Default
Notes
The name of the field
Input
Options
string
Default
Notes
When "field_type" is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects

Add Deal Follower#

Add a follower to a deal | key: addDealFollower

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the deal
Input
User Id
string
/ Required
Notes
The ID of the user

Add Deal Participant#

Add a participant to a deal | key: addDealParticipant

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the deal
Input
Person Id
string
/ Required
Notes
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

InputDefaultNotes
Input
Comments
string
Default
Notes
Any textual comment associated with this product-deal attachment
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Discount Percentage
string
Default
0
Notes
The discount %
Input
Duration
string
Default
1
Notes
The duration of the product (when product durations are not enabled for the company or if omitted, defaults to 1)
Input
Enabled Flag
string
Default
Notes
Whether the product is enabled on the deal or not
Input
Id
string
/ Required
Default
Notes
The ID of the deal
Input
Item Price
string
Default
Notes
The price at which this product will be added to the deal
Input
Product Variation Id
string
Default
Notes
The ID of the product variation to use
Input
Quantity
string
Default
Notes
Quantity – e
Input
Tax
string
Default
0
Notes
The tax percentage

Add File#

Add file | key: addFile

InputNotes
Input
Connection
connection
/ Required
Notes
 

Add File And Link It#

Create a remote file and link it to an item | key: addFileAndLinkIt

InputNotes
Input
Connection
connection
/ Required
Notes
 

Add Filter#

Add a new filter | key: addFilter

InputNotes
Input
Conditions
string
/ Required
Notes
The conditions of the filter as a JSON object
Input
Connection
connection
/ Required
Notes
 
Input
Name
string
/ Required
Notes
The name of the filter
Input
Type
string
/ Required
Notes
The type of filter to create

Add Goal#

Add a new goal | key: addGoal

InputNotes
Input
Assignee
string
Notes
Who this goal is assigned to
Input
Connection
connection
/ Required
Notes
 
Input
Duration
string
Notes
The date when the goal starts and ends
Input
Expected Outcome
string
Notes
The expected outcome of the goal
Input
Interval
string
Notes
The interval of the goal
Input
Title
string
Notes
The title of the goal
Input
Type
string
Notes
The type of the goal

Add Lead#

Add a lead | key: addLead

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Expected Close Date
string
Default
Notes
The date of when the deal which will be created from the lead is expected to be closed
Input
Label Ids
string
Default
Notes
The IDs of the lead labels which will be associated with the lead
Input
Organization Id
string
Default
Notes
The ID of an organization which this lead will be linked to
Input
Owner Id
string
Default
Notes
The ID of the user which will be the owner of the created lead
Input
Person Id
string
Default
Notes
The ID of a person which this lead will be linked to
Input
Title
string
/ Required
Default
Notes
The name of the lead
Input
Value
string
Default
Notes
The potential value of the lead
Input
Visible To
string
Default
Notes
The visibility of the lead
Input
Was Seen
boolean
Default
false
Notes
A flag indicating whether the lead was seen by someone in the Pipedrive UI

Add Lead Label#

Add a lead label | key: addLeadLabel

InputNotes
Input
Color
string
/ Required
Notes
The color of the label
Input
Connection
connection
/ Required
Notes
 
Input
Name
string
/ Required
Notes
The name of the lead label

Add Note#

Add a note | key: addNote

InputNotes
Input
Add Time
string
Notes
The optional creation date & time of the note in UTC
Input
Connection
connection
/ Required
Notes
 
Input
Content
string
Notes
The content of the note in HTML format
Input
Deal Id
string
Notes
The ID of the deal the note will be attached to
Input
Lead Id
string
Notes
The ID of the lead the note will be attached to
Input
Org Id
string
Notes
The ID of the organization this note will be attached to
Input
Person Id
string
Notes
The ID of the person this note will be attached to
Input
Pinned To Deal Flag
string
Notes
If set, the results are filtered by note to deal pinning state ("deal_id" is also required)
Input
Pinned To Lead Flag
string
Notes
If set, the results are filtered by note to lead pinning state ("lead_id" is also required)
Input
Pinned To Organization Flag
string
Notes
If set, the results are filtered by note to organization pinning state ("org_id" is also required)
Input
Pinned To Person Flag
string
Notes
If set, the results are filtered by note to person pinning state ("person_id" is also required)
Input
User Id
string
Notes
The ID of the user who will be marked as the author of the note

Add Note Comment#

Add a comment to a note | key: addNoteComment

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Content
string
/ Required
Notes
The content of the comment in HTML format
Input
Id
string
/ Required
Notes
The ID of the note

Add Or Update Role Setting#

Add or update role setting | key: addOrUpdateRoleSetting

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the role

Add Organization#

Add an organization | key: addOrganization

InputNotes
Input
Add Time
string
Notes
The optional creation date & time of the organization in UTC
Input
Connection
connection
/ Required
Notes
 
Input
Name
string
Notes
The name of the organization
Input
Owner Id
string
Notes
The ID of the user who will be marked as the owner of this organization
Input
Visible To
string
Notes
The visibility of the organization

Add Organization Field#

Add a new organization field | key: addOrganizationField

InputDefaultNotes
Input
Add Visible Flag
boolean
Default
true
Notes
Whether the field is available in the "add new" modal or not (both in the web and mobile app)
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Field Type
string
Default
Notes
The type of the fieldValueDescription"address"Address field (has multiple subfields, autocompleted by Google Maps)"date"Date (format YYYY-MM-DD)"daterange"Date-range field (has a start date and end date value, both YYYY-MM-DD)"double"Numeric value"enum"Options field with a single possible chosen option"monetary"Monetary field (has a numeric value and a currency value)"org"Organization field (contains an organization ID which is stored on the same account)"people"Person field (contains a person ID which is stored on the same account)"phone"Phone field (up to 255 numbers and/or characters)"set"Options field with a possibility of having multiple chosen options"text"Long text (up to 65k characters)"time"Time field (format HH:MM:SS)"timerange"Time-range field (has a start time and end time value, both HH:MM:SS)"user"User field (contains a user ID of another Pipedrive user)"varchar"Text (up to 255 characters)"varchar_auto"Autocomplete text (up to 255 characters)"visible_to"System field that keeps item"s visibility setting
Input
Name
string
Default
Notes
The name of the field
Input
Options
string
Default
Notes
When "field_type" is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects

Add Organization Follower#

Add a follower to an organization | key: addOrganizationFollower

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the organization
Input
User Id
string
/ Required
Notes
The ID of the user

Add Organization Relationship#

Create an organization relationship | key: addOrganizationRelationship

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Org Id
string
Notes
The ID of the base organization for the returned calculated values
Input
Rel Linked Org Id
string
/ Required
Notes
The linked organization in the relationship
Input
Rel Owner Org Id
string
/ Required
Notes
The owner of the relationship
Input
Type
string
/ Required
Notes
The type of organization relationship

Add Person#

Add a person | key: addPerson

InputNotes
Input
Add Time
string
Notes
The optional creation date & time of the person in UTC
Input
Connection
connection
/ Required
Notes
 
Input
Email
string
Notes
List of email data related to the person
Input
Marketing Status
string
Notes
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
Input
Name
string
Notes
The name of the person
Input
Org Id
string
Notes
The ID of the organization this person will belong to
Input
Owner Id
string
Notes
The ID of the user who will be marked as the owner of this person
Input
Phone
string
Notes
List of phone data related to the person
Input
Visible To
string
Notes
The visibility of the person

Add Person Field#

Add a new person field | key: addPersonField

InputDefaultNotes
Input
Add Visible Flag
boolean
Default
true
Notes
Whether the field is available in the "add new" modal or not (both in the web and mobile app)
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Field Type
string
Default
Notes
The type of the fieldValueDescription"address"Address field (has multiple subfields, autocompleted by Google Maps)"date"Date (format YYYY-MM-DD)"daterange"Date-range field (has a start date and end date value, both YYYY-MM-DD)"double"Numeric value"enum"Options field with a single possible chosen option"monetary"Monetary field (has a numeric value and a currency value)"org"Organization field (contains an organization ID which is stored on the same account)"people"Person field (contains a person ID which is stored on the same account)"phone"Phone field (up to 255 numbers and/or characters)"set"Options field with a possibility of having multiple chosen options"text"Long text (up to 65k characters)"time"Time field (format HH:MM:SS)"timerange"Time-range field (has a start time and end time value, both HH:MM:SS)"user"User field (contains a user ID of another Pipedrive user)"varchar"Text (up to 255 characters)"varchar_auto"Autocomplete text (up to 255 characters)"visible_to"System field that keeps item"s visibility setting
Input
Name
string
Default
Notes
The name of the field
Input
Options
string
Default
Notes
When "field_type" is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects

Add Person Follower#

Add a follower to a person | key: addPersonFollower

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the person
Input
User Id
string
/ Required
Notes
The ID of the user

Add Person Picture#

Add person picture | key: addPersonPicture

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the person

Add Pipeline#

Add a new pipeline | key: addPipeline

InputNotes
Input
Active
string
Notes
Whether this pipeline will be made inactive (hidden) or active
Input
Connection
connection
/ Required
Notes
 
Input
Deal Probability
string
Notes
Whether deal probability is disabled or enabled for this pipeline
Input
Name
string
/ Required
Notes
The name of the pipeline
Input
Order Nr
string
Notes
Defines the order of pipelines

Add Product#

Add a product | key: addProduct

InputDefaultNotes
Input
Active Flag
string
Default
1
Notes
Whether this product will be made active or not
Input
Code
string
Default
Notes
The product code
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Name
string
Default
Notes
The name of the product
Input
Owner Id
string
Default
Notes
The ID of the user who will be marked as the owner of this product
Input
Prices
string
Default
Notes
An array of objects, each containing: "currency" (string), "price" (number), "cost" (number, optional), "overhead_cost" (number, optional)
Input
Selectable
string
Default
1
Notes
Whether this product can be selected in deals or not
Input
Tax
string
Default
0
Notes
The tax percentage
Input
Unit
string
Default
Notes
The unit in which this product is sold
Input
Visible To
string
Default
Notes
The visibility of the product

Add Product Field#

Add a new product field | key: addProductField

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Field Type
string
/ Required
Notes
The type of the fieldValueDescription"varchar"Text (up to 255 characters)"varchar_auto"Autocomplete text (up to 255 characters)"text"Long text (up to 65k characters)"double"Numeric value"monetary"Monetary field (has a numeric value and a currency value)"date"Date (format YYYY-MM-DD)"set"Options field with a possibility of having multiple chosen options"enum"Options field with a single possible chosen option"user"User field (contains a user ID of another Pipedrive user)"org"Organization field (contains an organization ID which is stored on the same account)"people"Person field (contains a product ID which is stored on the same account)"phone"Phone field (up to 255 numbers and/or characters)"time"Time field (format HH:MM:SS)"timerange"Time-range field (has a start time and end time value, both HH:MM:SS)"daterange"Date-range field (has a start date and end date value, both YYYY-MM-DD)"address"Address field (autocompleted by Google Maps)
Input
Name
string
/ Required
Notes
The name of the field
Input
Options
string
Notes
When "field_type" is either "set" or "enum", possible options must be supplied as a JSON-encoded sequential array, for example:"[{"label":"red"}, {"label":"blue"}, {"label":"lilac"}]"

Add Product Follower#

Add a follower to a product | key: addProductFollower

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the product
Input
User Id
string
/ Required
Notes
The ID of the user

Add Recurring Subscription#

Add a recurring subscription | key: addRecurringSubscription

InputDefaultNotes
Input
Cadence Type
string
/ Required
Default
Notes
The interval between payments
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Currency
string
/ Required
Default
Notes
The currency of the recurring subscription
Input
Cycle Amount
string
/ Required
Default
Notes
The amount of each payment
Input
Cycles Count
string
Default
Notes
Shows how many payments the subscription has
Input
Deal Id
string
/ Required
Default
Notes
The ID of the deal this recurring subscription is associated with
Input
Description
string
Default
Notes
The description of the recurring subscription
Input
Infinite
boolean
Default
false
Notes
This indicates that the recurring subscription will last until it"s manually canceled or deleted
Input
Payments
string
Default
Notes
Array of additional payments
Input
Start Date
string
/ Required
Default
Notes
The start date of the recurring subscription
Input
Update Deal Value
boolean
Default
false
Notes
Indicates that the deal value must be set to recurring subscription"s MRR value

Add Role#

Add a role | key: addRole

InputNotes
Input
Connection
connection
/ Required
Notes
 

Add Role Assignment#

Add role assignment | key: addRoleAssignment

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the role

Add Stage#

Add a new stage | key: addStage

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Deal Probability
string
Default
Notes
The success probability percentage of the deal
Input
Name
string
/ Required
Default
Notes
The name of the stage
Input
Pipeline Id
string
/ Required
Default
Notes
The ID of the pipeline to add stage to
Input
Rotten Days
string
Default
Notes
The number of days the deals not updated in this stage would become rotten
Input
Rotten Flag
boolean
Default
false
Notes
Whether deals in this stage can become rotten

Add Subscription Installment#

Add an installment subscription | key: addSubscriptionInstallment

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Currency
string
/ Required
Default
Notes
The currency of the installment subscription
Input
Deal Id
string
/ Required
Default
Notes
The ID of the deal this installment subscription is associated with
Input
Payments
string
/ Required
Default
Notes
Array of payments
Input
Update Deal Value
boolean
Default
false
Notes
Indicates that the deal value must be set to the installment subscription"s total value

Add Team#

Add a new team | key: addTeam

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Description
string
Notes
The team description
Input
Manager Id
string
/ Required
Notes
The team manager ID
Input
Name
string
/ Required
Notes
The team name
Input
Users
string
Notes
The IDs of the users that belong to the team

Add Team User#

Add users to a team | key: addTeamUser

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the team
Input
Users
string
/ Required
Notes
The list of user IDs

Add User#

Add a new user | key: addUser

InputNotes
Input
Connection
connection
/ Required
Notes
 

Add User Role Assignment#

Add role assignment | key: addUserRoleAssignment

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the user

Add Webhook#

Create a new Webhook | key: addWebhook

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Event Action
string
/ Required
Notes
The type of action to receive notifications about
Input
Event Object
string
/ Required
Notes
The type of object to receive notifications about
Input
Http Auth Password
string
Notes
The HTTP basic auth password of the subscription URL endpoint (if required)
Input
Http Auth User
string
Notes
The HTTP basic auth username of the subscription URL endpoint (if required)
Input
Subscription Url
string
/ Required
Notes
A full, valid, publicly accessible URL which determines where to send the notifications
Input
User Id
string
Notes
The ID of the user this Webhook will be authorized with

Cancel Recurring Subscription#

Cancel a recurring subscription | key: cancelRecurringSubscription

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
End Date
string
Notes
The subscription termination date
Input
Id
string
/ Required
Notes
The ID of the subscription

Delete Activities#

Delete multiple activities in bulk | key: deleteActivities

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Ids
string
/ Required
Notes
The comma-separated IDs of activities that will be deleted

Delete Activity#

Delete an activity | key: deleteActivity

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the activity

Delete Activity Type#

Delete an activity type | key: deleteActivityType

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the activity type

Delete Activity Types#

Delete multiple activity types in bulk | key: deleteActivityTypes

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Ids
string
/ Required
Notes
The comma-separated activity type IDs

Delete Call Log#

Delete a call log | key: deleteCallLog

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Id
string
/ Required
Notes
The ID received when you create the call log
Example
3cde3b05035cae14dcfc172bd8000d08

Delete Channel#

Delete a channel | key: deleteChannel

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the channel provided by the integration

Delete Comment#

Delete a comment related to a note | key: deleteComment

InputNotes
Input
Comment Id
string
/ Required
Notes
The ID of the comment
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the note

Delete Conversation#

Delete a conversation | key: deleteConversation

InputNotes
Input
Channel Id
string
/ Required
Notes
The ID of the channel provided by the integration
Input
Connection
connection
/ Required
Notes
 
Input
Conversation Id
string
/ Required
Notes
The ID of the conversation provided by the integration

Delete Deal#

Delete a deal | key: deleteDeal

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the deal

Delete Deal Field#

Delete a deal field | key: deleteDealField

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the field

Delete Deal Fields#

Delete multiple deal fields in bulk | key: deleteDealFields

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Ids
string
/ Required
Notes
The comma-separated field IDs to delete

Delete Deal Follower#

Delete a follower from a deal | key: deleteDealFollower

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Follower Id
string
/ Required
Notes
The ID of the follower
Input
Id
string
/ Required
Notes
The ID of the deal

Delete Deal Participant#

Delete a participant from a deal | key: deleteDealParticipant

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Deal Participant Id
string
/ Required
Notes
The ID of the participant of the deal
Input
Id
string
/ Required
Notes
The ID of the deal

Delete Deal Product#

Delete an attached product from a deal | key: deleteDealProduct

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the deal
Input
Product Attachment Id
string
/ Required
Notes
The product attachment ID

Delete Deals#

Delete multiple deals in bulk | key: deleteDeals

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Ids
string
/ Required
Notes
The comma-separated IDs that will be deleted

Delete File#

Delete a file | key: deleteFile

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the file

Delete Filter#

Delete a filter | key: deleteFilter

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the filter

Delete Filters#

Delete multiple filters in bulk | key: deleteFilters

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Ids
string
/ Required
Notes
The comma-separated filter IDs to delete

Delete Global Message#

Dismiss a global message | key: deleteGlobalMessage

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the global message to be dismissed

Delete Goal#

Delete existing goal | key: deleteGoal

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the goal to be deleted

Delete Lead#

Delete a lead | key: deleteLead

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the lead

Delete Lead Label#

Delete a lead label | key: deleteLeadLabel

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the lead label

Delete Mail Thread#

Delete mail thread | key: deleteMailThread

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the mail thread

Delete Note#

Delete a note | key: deleteNote

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the note

Delete Organization#

Delete an organization | key: deleteOrganization

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the organization

Delete Organization Field#

Delete an organization field | key: deleteOrganizationField

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the field

Delete Organization Fields#

Delete multiple organization fields in bulk | key: deleteOrganizationFields

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Ids
string
/ Required
Notes
The comma-separated field IDs to delete

Delete Organization Follower#

Delete a follower from an organization | key: deleteOrganizationFollower

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Follower Id
string
/ Required
Notes
The ID of the follower
Input
Id
string
/ Required
Notes
The ID of the organization

Delete Organization Relationship#

Delete an organization relationship | key: deleteOrganizationRelationship

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the organization relationship

Delete Organizations#

Delete multiple organizations in bulk | key: deleteOrganizations

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Ids
string
/ Required
Notes
The comma-separated IDs that will be deleted

Delete Person#

Delete a person | key: deletePerson

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the person

Delete Person Field#

Delete a person field | key: deletePersonField

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the field

Delete Person Fields#

Delete multiple person fields in bulk | key: deletePersonFields

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Ids
string
/ Required
Notes
The comma-separated field IDs to delete

Delete Person Follower#

Delete a follower from a person | key: deletePersonFollower

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Follower Id
string
/ Required
Notes
The ID of the follower
Input
Id
string
/ Required
Notes
The ID of the person

Delete Person Picture#

Delete person picture | key: deletePersonPicture

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the person

Delete Persons#

Delete multiple persons in bulk | key: deletePersons

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Ids
string
/ Required
Notes
The comma-separated IDs that will be deleted

Delete Pipeline#

Delete a pipeline | key: deletePipeline

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the pipeline

Delete Product#

Delete a product | key: deleteProduct

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the product

Delete Product Field#

Delete a product field | key: deleteProductField

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the product field

Delete Product Fields#

Delete multiple product fields in bulk | key: deleteProductFields

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Ids
string
/ Required
Notes
The comma-separated field IDs to delete

Delete Product Follower#

Delete a follower from a product | key: deleteProductFollower

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Follower Id
string
/ Required
Notes
The ID of the relationship between the follower and the product
Input
Id
string
/ Required
Notes
The ID of the product

Delete Role#

Delete a role | key: deleteRole

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the role

Delete Role Assignment#

Delete a role assignment | key: deleteRoleAssignment

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the role

Delete Stage#

Delete a stage | key: deleteStage

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the stage

Delete Stages#

Delete multiple stages in bulk | key: deleteStages

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Ids
string
/ Required
Notes
The comma-separated stage IDs to delete

Delete Subscription#

Delete a subscription | key: deleteSubscription

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the subscription

Delete Team User#

Delete users from a team | key: deleteTeamUser

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the team
Input
Users
string
/ Required
Notes
The list of user IDs

Delete User Role Assignment#

Delete a role assignment | key: deleteUserRoleAssignment

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the user

Delete Webhook#

Delete existing Webhook | key: deleteWebhook

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the Webhook to delete

Download File#

Download one file | key: downloadFile

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the file

Duplicate Deal#

Duplicate deal | key: duplicateDeal

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the deal

Find Subscription By Deal#

Find subscription by deal | key: findSubscriptionByDeal

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Deal Id
string
/ Required
Notes
The ID of the deal

Find Users By Name#

Find users by name | key: findUsersByName

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Search By Email
string
Default
1
Notes
When enabled, the term will only be matched against email addresses of users
Input
Term
string
/ Required
Default
Notes
The search term to look for

Get Activities#

Get all activities assigned to a particular user | key: getActivities

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Done
string
Notes
Whether the activity is done or not
Example
 
Input
End Date
string
Notes
Use the activity due date where you wish to stop fetching activities from
Example
 
Input
Filter Id
string
Notes
The ID of the filter to use (will narrow down results if used together with "user_id" parameter)
Example
 
Input
Limit
string
Notes
For pagination, the limit of entries to be returned
Example
100
Input
Start
string
Notes
For pagination, the position that represents the first result for the page
Example
0
Input
Start Date
string
Notes
Use the activity due date where you wish to begin fetching activities from
Example
 
Input
Type
string
Notes
The type of the activity, can be one type or multiple types separated by a comma
Example
 
Input
User Id
string
Notes
The ID of the user whose activities will be fetched
Example
 

Get Activity#

Get details of an activity | key: getActivity

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the activity

Get Activity Fields#

Get all activity fields | key: getActivityFields

InputNotes
Input
Connection
connection
/ Required
Notes
 

Get Activity Types#

Get all activity types | key: getActivityTypes

InputNotes
Input
Connection
connection
/ Required
Notes
 

Get Call Log#

Get details of a call log | key: getCallLog

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Id
string
/ Required
Notes
The ID received when you create the call log
Example
3cde3b05035cae14dcfc172bd8000d08

Get Comment#

Get one comment | key: getComment

InputNotes
Input
Comment Id
string
/ Required
Notes
The ID of the comment
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the note

Get Company Addons#

Get all add-ons for a single company | key: getCompanyAddons

InputNotes
Input
Connection
connection
/ Required
Notes
 

Get Currencies#

Get all supported currencies | key: getCurrencies

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Term
string
Notes
Optional search term that is searched for from currency"s name and/or code

Get Current User#

Get current user data | key: getCurrentUser

InputNotes
Input
Connection
connection
/ Required
Notes
 

Get Deal#

Get details of a deal | key: getDeal

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the deal

Get Deal Activities#

List activities associated with a deal | key: getDealActivities

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Done
string
Default
Notes
Whether the activity is done or not
Input
Exclude
string
Default
Notes
A comma-separated string of activity IDs to exclude from result
Input
Id
string
/ Required
Default
Notes
The ID of the deal
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Deal Field#

Get one deal field | key: getDealField

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the field

Get Deal Fields#

Get all deal fields | key: getDealFields

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Deal Files#

List files attached to a deal | key: getDealFiles

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the deal
Input
Include Deleted Files
string
Default
Notes
When enabled, the list of files will also include deleted files
Input
Limit
string
Default
Notes
Items shown per page
Input
Sort
string
Default
Notes
The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC")
Input
Start
string
Default
0
Notes
Pagination start

Get Deal Followers#

List followers of a deal | key: getDealFollowers

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the deal

Get Deal Mail Messages#

List mail messages associated with a deal | key: getDealMailMessages

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the deal
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Deal Participants#

List participants of a deal | key: getDealParticipants

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the deal
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Deal Persons#

List all persons associated with a deal | key: getDealPersons

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the deal
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Deal Products#

List products attached to a deal | key: getDealProducts

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the deal
Input
Include Product Data
string
Default
Notes
Whether to fetch product data along with each attached product (1) or not (0, default)
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Deal Updates#

List updates about a deal | key: getDealUpdates

InputDefaultNotes
Input
All Changes
string
Default
Notes
Whether to show custom field updates or not
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the deal
Input
Items
string
Default
Notes
A comma-separated string for filtering out item specific updates
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Deal Users#

List permitted users | key: getDealUsers

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the deal

Get Deals#

Get all deals | key: getDeals

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Filter Id
string
Default
Notes
The ID of the filter to use
Input
Limit
string
Default
Notes
Items shown per page
Input
Owned By You
string
Default
Notes
When supplied, only deals owned by you are returned
Input
Sort
string
Default
Notes
The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC")
Input
Stage Id
string
Default
Notes
If supplied, only deals within the given stage will be returned
Input
Start
string
Default
0
Notes
Pagination start
Input
Status
string
Default
all_not_deleted
Notes
Only fetch deals with a specific status
Input
User Id
string
Default
Notes
If supplied, only deals matching the given user will be returned

Get Deals Summary#

Get deals summary | key: getDealsSummary

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Filter Id
string
Notes
user_id will not be considered
Input
Stage Id
string
Notes
Only deals within the given stage will be returned
Input
Status
string
Notes
Only fetch deals with a specific status
Input
User Id
string
Notes
Only deals matching the given user will be returned

Get Deals Timeline#

Get deals timeline | key: getDealsTimeline

InputNotes
Input
Amount
string
/ Required
Notes
The number of given intervals, starting from "start_date", to fetch
Input
Connection
connection
/ Required
Notes
 
Input
Exclude Deals
string
Notes
Whether to exclude deals list (1) or not (0)
Input
Field Key
string
/ Required
Notes
The date field key which deals will be retrieved from
Input
Filter Id
string
Notes
If supplied, only deals matching the given filter will be returned
Input
Interval
string
/ Required
Notes
The type of the intervalValueDescription"day"Day"week"A full week (7 days) starting from "start_date""month"A full month (depending on the number of days in given month) starting from "start_date""quarter"A full quarter (3 months) starting from "start_date"
Input
Pipeline Id
string
Notes
If supplied, only deals matching the given pipeline will be returned
Input
Start Date
string
/ Required
Notes
The date when the first interval starts
Input
Totals Convert Currency
string
Notes
The 3-letter currency code of any of the supported currencies
Input
User Id
string
Notes
If supplied, only deals matching the given user will be returned

Get File#

Get one file | key: getFile

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the file

Get Files#

Get all files | key: getFiles

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Include Deleted Files
string
Default
Notes
When enabled, the list of files will also include deleted files
Input
Limit
string
Default
Notes
Items shown per page
Input
Sort
string
Default
Notes
The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC")
Input
Start
string
Default
0
Notes
Pagination start

Get Filter#

Get one filter | key: getFilter

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the filter

Get Filter Helpers#

Get all filter helpers | key: getFilterHelpers

InputNotes
Input
Connection
connection
/ Required
Notes
 

Get Filters#

Get all filters | key: getFilters

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Type
string
Notes
The types of filters to fetch

Get Global Messages#

Get global messages | key: getGlobalMessages

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Limit
string
Default
1
Notes
The number of messages to get from 1 to 100

Get Goal Result#

Get result of a goal | key: getGoalResult

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the goal that the results are looked for
Input
Period End
string
/ Required
Notes
The end date of the period for which to find progress of a goal
Input
Period Start
string
/ Required
Notes
The start date of the period for which to find progress of a goal

Get Goals#

Find goals | key: getGoals

InputDefaultNotes
Input
Assignee Id
string
Default
Notes
The ID of the user who"s goal to fetch
Input
Assignee Type
string
Default
Notes
The type of the goal"s assignee
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Expected Outcome Currency Id
string
Default
Notes
The numeric ID of the goal"s currency
Input
Expected Outcome Target
string
Default
Notes
The numeric value of the outcome
Input
Expected Outcome Tracking Metric
string
Default
Notes
The tracking metric of the expected outcome of the goal
Input
Is Active
boolean
Default
true
Notes
Whether the goal is active or not
Input
Period End
string
Default
Notes
The end date of the period for which to find goals
Input
Period Start
string
Default
Notes
The start date of the period for which to find goals
Input
Title
string
Default
Notes
The title of the goal
Input
Type Name
string
Default
Notes
The type of the goal
Input
Type Params Activity Type Id
string
Default
Notes
The ID of the activity type
Input
Type Params Pipeline Id
string
Default
Notes
The ID of the pipeline or "null" for all pipelines
Input
Type Params Stage Id
string
Default
Notes
The ID of the stage

Get Lead#

Get one lead | key: getLead

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the lead

Get Lead Labels#

Get all lead labels | key: getLeadLabels

InputNotes
Input
Connection
connection
/ Required
Notes
 

Get Lead Sources#

Get all lead sources | key: getLeadSources

InputNotes
Input
Connection
connection
/ Required
Notes
 

Get Leads#

Get all leads | key: getLeads

InputNotesExample
Input
Archived Status
string
Notes
Filtering based on the archived status of a lead
Example
 
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Filter Id
string
Notes
The ID of the filter to use
Example
1
Input
Limit
string
Notes
For pagination, the limit of entries to be returned
Example
100
Input
Owner Id
string
Notes
If supplied, only leads matching the given user will be returned
Example
1
Input
Sort
string
Notes
The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC")
Example
 
Input
Start
string
Notes
For pagination, the position that represents the first result for the page
Example
0

Get Mail Message#

Get one mail message | key: getMailMessage

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the mail message to fetch
Input
Include Body
string
Default
1
Notes
Whether to include the full message body or not

Get Mail Thread#

Get one mail thread | key: getMailThread

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the mail thread

Get Mail Thread Messages#

Get all mail messages of mail thread | key: getMailThreadMessages

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the mail thread

Get Mail Threads#

Get mail threads | key: getMailThreads

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Folder
string
/ Required
Default
inbox
Notes
The type of folder to fetch
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Note#

Get one note | key: getNote

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the note

Get Note Comments#

Get all comments for a note | key: getNoteComments

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the note
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Note Fields#

Get all note fields | key: getNoteFields

InputNotes
Input
Connection
connection
/ Required
Notes
 

Get Notes#

Get all notes | key: getNotes

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Deal Id
string
Default
Notes
The ID of the deal which notes to fetch
Input
End Date
string
Default
Notes
The date in format of YYYY-MM-DD until which notes to fetch to
Input
Lead Id
string
Default
Notes
The ID of the lead which notes to fetch
Input
Limit
string
Default
Notes
Items shown per page
Input
Org Id
string
Default
Notes
The ID of the organization which notes to fetch
Input
Person Id
string
Default
Notes
The ID of the person whose notes to fetch
Input
Pinned To Deal Flag
string
Default
Notes
If set, the results are filtered by note to deal pinning state
Input
Pinned To Lead Flag
string
Default
Notes
If set, the results are filtered by note to lead pinning state
Input
Pinned To Organization Flag
string
Default
Notes
If set, the results are filtered by note to organization pinning state
Input
Pinned To Person Flag
string
Default
Notes
If set, the results are filtered by note to person pinning state
Input
Sort
string
Default
Notes
The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC")
Input
Start
string
Default
0
Notes
Pagination start
Input
Start Date
string
Default
Notes
The date in format of YYYY-MM-DD from which notes to fetch
Input
User Id
string
Default
Notes
The ID of the user whose notes to fetch

Get Organization#

Get details of an organization | key: getOrganization

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the organization

Get Organization Activities#

List activities associated with an organization | key: getOrganizationActivities

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Done
string
Default
Notes
Whether the activity is done or not
Input
Exclude
string
Default
Notes
A comma-separated string of activity IDs to exclude from result
Input
Id
string
/ Required
Default
Notes
The ID of the organization
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Organization Deals#

List deals associated with an organization | key: getOrganizationDeals

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the organization
Input
Limit
string
Default
Notes
Items shown per page
Input
Only Primary Association
string
Default
Notes
If set, only deals that are directly associated to the organization are fetched
Input
Sort
string
Default
Notes
The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC")
Input
Start
string
Default
0
Notes
Pagination start
Input
Status
string
Default
all_not_deleted
Notes
Only fetch deals with a specific status

Get Organization Field#

Get one organization field | key: getOrganizationField

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the field

Get Organization Fields#

Get all organization fields | key: getOrganizationFields

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Organization Files#

List files attached to an organization | key: getOrganizationFiles

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the organization
Input
Include Deleted Files
string
Default
Notes
When enabled, the list of files will also include deleted files
Input
Limit
string
Default
Notes
Items shown per page
Input
Sort
string
Default
Notes
The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC")
Input
Start
string
Default
0
Notes
Pagination start

Get Organization Followers#

List followers of an organization | key: getOrganizationFollowers

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the organization

Get Organization Mail Messages#

List mail messages associated with an organization | key: getOrganizationMailMessages

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the organization
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Organization Persons#

List persons of an organization | key: getOrganizationPersons

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the organization
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Organization Relationship#

Get one organization relationship | key: getOrganizationRelationship

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the organization relationship
Input
Org Id
string
Notes
The ID of the base organization for the returned calculated values

Get Organization Relationships#

Get all relationships for organization | key: getOrganizationRelationships

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Org Id
string
/ Required
Notes
The ID of the organization to get relationships for

Get Organization Updates#

List updates about an organization | key: getOrganizationUpdates

InputDefaultNotes
Input
All Changes
string
Default
Notes
Whether to show custom field updates or not
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the organization
Input
Items
string
Default
Notes
A comma-separated string for filtering out item specific updates
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Organization Users#

List permitted users | key: getOrganizationUsers

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the organization

Get Organizations#

Get all organizations | key: getOrganizations

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Filter Id
string
Default
Notes
The ID of the filter to use
Input
First Char
string
Default
Notes
If supplied, only organizations whose name starts with the specified letter will be returned (case insensitive)
Input
Limit
string
Default
Notes
Items shown per page
Input
Sort
string
Default
Notes
The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC")
Input
Start
string
Default
0
Notes
Pagination start
Input
User Id
string
Default
Notes
If supplied, only organizations owned by the given user will be returned

Get Permission Set#

Get one permission set | key: getPermissionSet

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the permission set

Get Permission Set Assignments#

List permission set assignments | key: getPermissionSetAssignments

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the permission set
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Permission Sets#

Get all permission sets | key: getPermissionSets

InputNotes
Input
Connection
connection
/ Required
Notes
 

Get Person#

Get details of a person | key: getPerson

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the person

Get Person Activities#

List activities associated with a person | key: getPersonActivities

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Done
string
Default
Notes
Whether the activity is done or not
Input
Exclude
string
Default
Notes
A comma-separated string of activity IDs to exclude from result
Input
Id
string
/ Required
Default
Notes
The ID of the person
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Person Deals#

List deals associated with a person | key: getPersonDeals

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the person
Input
Limit
string
Default
Notes
Items shown per page
Input
Sort
string
Default
Notes
The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC")
Input
Start
string
Default
0
Notes
Pagination start
Input
Status
string
Default
all_not_deleted
Notes
Only fetch deals with a specific status

Get Person Field#

Get one person field | key: getPersonField

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the field

Get Person Fields#

Get all person fields | key: getPersonFields

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Person Files#

List files attached to a person | key: getPersonFiles

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the person
Input
Include Deleted Files
string
Default
Notes
When enabled, the list of files will also include deleted files
Input
Limit
string
Default
Notes
Items shown per page
Input
Sort
string
Default
Notes
The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC")
Input
Start
string
Default
0
Notes
Pagination start

Get Person Followers#

List followers of a person | key: getPersonFollowers

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the person

Get Person Mail Messages#

List mail messages associated with a person | key: getPersonMailMessages

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the person
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Person Products#

List products associated with a person | key: getPersonProducts

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the person
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Person Updates#

List updates about a person | key: getPersonUpdates

InputDefaultNotes
Input
All Changes
string
Default
Notes
Whether to show custom field updates or not
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the person
Input
Items
string
Default
Notes
A comma-separated string for filtering out item specific updates
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Person Users#

List permitted users | key: getPersonUsers

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the person

Get Persons#

Get all persons | key: getPersons

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Filter Id
string
Default
Notes
The ID of the filter to use
Input
First Char
string
Default
Notes
If supplied, only persons whose name starts with the specified letter will be returned (case insensitive)
Input
Limit
string
Default
Notes
Items shown per page
Input
Sort
string
Default
Notes
The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC")
Input
Start
string
Default
0
Notes
Pagination start
Input
User Id
string
Default
Notes
If supplied, only persons owned by the given user will be returned

Get Pipeline#

Get one pipeline | key: getPipeline

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the pipeline
Input
Totals Convert Currency
string
Notes
The 3-letter currency code of any of the supported currencies

Get Pipeline Conversion Statistics#

Get deals conversion rates in pipeline | key: getPipelineConversionStatistics

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
End Date
string
/ Required
Notes
The end of the period
Input
Id
string
/ Required
Notes
The ID of the pipeline
Input
Start Date
string
/ Required
Notes
The start of the period
Input
User Id
string
Notes
The ID of the user who"s pipeline metrics statistics to fetch

Get Pipeline Deals#

Get deals in a pipeline | key: getPipelineDeals

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Everyone
string
Default
Notes
If supplied, "filter_id" and "user_id" will not be considered – instead, deals owned by everyone will be returned
Input
Filter Id
string
Default
Notes
If supplied, only deals matching the given filter will be returned
Input
Get Summary
string
Default
Notes
Whether to include a summary of the pipeline in the "additional_data" or not
Input
Id
string
/ Required
Default
Notes
The ID of the pipeline
Input
Limit
string
Default
Notes
Items shown per page
Input
Stage Id
string
Default
Notes
If supplied, only deals within the given stage will be returned
Input
Start
string
Default
0
Notes
Pagination start
Input
Totals Convert Currency
string
Default
Notes
The 3-letter currency code of any of the supported currencies
Input
User Id
string
Default
Notes
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

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
End Date
string
/ Required
Notes
The end of the period
Input
Id
string
/ Required
Notes
The ID of the pipeline
Input
Start Date
string
/ Required
Notes
The start of the period
Input
User Id
string
Notes
The ID of the user who"s pipeline statistics to fetch

Get Pipelines#

Get all pipelines | key: getPipelines

InputNotes
Input
Connection
connection
/ Required
Notes
 

Get Product#

Get one product | key: getProduct

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the product

Get Product Deals#

Get deals where a product is attached to | key: getProductDeals

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the product
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start
Input
Status
string
Default
all_not_deleted
Notes
Only fetch deals with a specific status

Get Product Field#

Get one product field | key: getProductField

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the product field

Get Product Fields#

Get all product fields | key: getProductFields

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Product Files#

List files attached to a product | key: getProductFiles

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the product
Input
Include Deleted Files
string
Default
Notes
When enabled, the list of files will also include deleted files
Input
Limit
string
Default
Notes
Items shown per page
Input
Sort
string
Default
Notes
The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC")
Input
Start
string
Default
0
Notes
Pagination start

Get Product Followers#

List followers of a product | key: getProductFollowers

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the product
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Product Users#

List permitted users | key: getProductUsers

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the product

Get Products#

Get all products | key: getProducts

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Filter Id
string
Default
Notes
The ID of the filter to use
Input
First Char
string
Default
Notes
If supplied, only products whose name starts with the specified letter will be returned (case insensitive)
Input
Get Summary
boolean
Default
false
Notes
If supplied, the response will return the total numbers of products in the "additional_data
Input
Ids
string
Default
Notes
An array of integers with the IDs of the products that should be returned in the response
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start
Input
User Id
string
Default
Notes
If supplied, only products owned by the given user will be returned

Get Recents#

Get recents | key: getRecents

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Items
string
Default
Notes
Multiple selection of item types to include in the query (optional)
Input
Limit
string
Default
Notes
Items shown per page
Input
Since Timestamp
string
/ Required
Default
Notes
The timestamp in UTC
Input
Start
string
Default
0
Notes
Pagination start

Get Role#

Get one role | key: getRole

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the role

Get Role Assignments#

List role assignments | key: getRoleAssignments

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the role
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Role Settings#

List role settings | key: getRoleSettings

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the role

Get Role Sub Roles#

List role sub-roles | key: getRoleSubRoles

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the role
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Roles#

Get all roles | key: getRoles

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get Stage#

Get one stage | key: getStage

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Everyone
string
Notes
If "everyone=1" is provided, deals summary will return deals owned by every user
Input
Id
string
/ Required
Notes
The ID of the stage

Get Stage Deals#

Get deals in a stage | key: getStageDeals

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Everyone
string
Default
Notes
If supplied, "filter_id" and "user_id" will not be considered – instead, deals owned by everyone will be returned
Input
Filter Id
string
Default
Notes
If supplied, only deals matching the given filter will be returned
Input
Id
string
/ Required
Default
Notes
The ID of the stage
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start
Input
User Id
string
Default
Notes
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

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Pipeline Id
string
Notes
The ID of the pipeline to fetch stages for

Get Subscription#

Get details of a subscription | key: getSubscription

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the subscription

Get Subscription Payments#

Get all payments of a subscription | key: getSubscriptionPayments

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the subscription

Get Team#

Get a single team | key: getTeam

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the team
Input
Skip Users
string
Default
1
Notes
When enabled, the teams will not include IDs of member users

Get Team Users#

Get all users in a team | key: getTeamUsers

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the team

Get Teams#

Get all teams | key: getTeams

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Order By
string
Default
id
Notes
The field name to sort returned teams by
Input
Skip Users
string
Default
1
Notes
When enabled, the teams will not include IDs of member users

Get User#

Get one user | key: getUser

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the user

Get User Call Logs#

Get all call logs assigned to a particular user | key: getUserCallLogs

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get User Connections#

Get all user connections | key: getUserConnections

InputNotes
Input
Connection
connection
/ Required
Notes
 

Get User Followers#

List followers of a user | key: getUserFollowers

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the user

Get User Permissions#

List user permissions | key: getUserPermissions

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the user

Get User Role Assignments#

List role assignments | key: getUserRoleAssignments

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the user
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start

Get User Role Settings#

List user role settings | key: getUserRoleSettings

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the user

Get User Settings#

List settings of an authorized user | key: getUserSettings

InputNotes
Input
Connection
connection
/ Required
Notes
 

Get User Teams#

Get all teams of a user | key: getUserTeams

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the user
Input
Order By
string
Default
id
Notes
The field name to sort returned teams by
Input
Skip Users
string
Default
1
Notes
When enabled, the teams will not include IDs of member users

Get Users#

Get all users | key: getUsers

InputNotes
Input
Connection
connection
/ Required
Notes
 

Get Webhooks#

Get all Webhooks | key: getWebhooks

InputNotes
Input
Connection
connection
/ Required
Notes
 

Link File To Item#

Link a remote file to an item | key: linkFileToItem

InputNotes
Input
Connection
connection
/ Required
Notes
 

Merge Deals#

Merge two deals | key: mergeDeals

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the deal
Input
Merge With Id
string
/ Required
Notes
The ID of the deal that the deal will be merged with

Merge Organizations#

Merge two organizations | key: mergeOrganizations

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the organization
Input
Merge With Id
string
/ Required
Notes
The ID of the organization that the organization will be merged with

Merge Persons#

Merge two persons | key: mergePersons

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the person
Input
Merge With Id
string
/ Required
Notes
The ID of the person that will not be overwritten

Raw Request#

Issue a raw HTTP request | key: rawRequest

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Data
string
Default
Notes
The HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step.
Example
{"exampleKey": "Example Data"}
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
File Data
string
Key Value List
Default
Notes
File Data to be sent as a multipart form upload.
Example
[{key: "example.txt", value: "My File Contents"}]
Input
Form Data
string
Key Value List
Default
Notes
The Form Data to be sent as a multipart form upload.
Example
[{"key": "Example Key", "value": new Buffer("Hello World")}]
Input
Header
string
Key Value List
Default
Notes
A list of headers to send with the request.
Example
User-Agent: curl/7.64.1
Input
Max Retry Count
string
Default
0
Notes
The maximum number of retries to attempt.
Example
 
Input
Method
string
/ Required
Default
Notes
The HTTP method to use.
Example
 
Input
Query Parameter
string
Key Value List
Default
Notes
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.
Example
 
Input
Response Type
string
/ Required
Default
json
Notes
The type of data you expect in the response. You can request json, text, or binary data.
Example
 
Input
Retry On All Errors
boolean
Default
false
Notes
If true, retries on all erroneous responses regardless of type.
Example
 
Input
Retry Delay (ms)
string
Default
0
Notes
The delay in milliseconds between retries.
Example
 
Input
Timeout
string
Default
Notes
The maximum time that a client will await a response to its request
Example
2000
Input
URL
string
/ Required
Default
Notes
This is the URL to call.
Example
/sobjects/Account
Input
Use Exponential Backoff
boolean
Default
false
Notes
Specifies whether to use a pre-defined exponential backoff strategy for retries.
Example
 

Receive Message#

Receives an incoming message | key: receiveMessage

InputNotes
Input
Attachments
string
Notes
The list of attachments available in the message
Input
Channel Id
string
/ Required
Notes
The channel ID as in the provider
Input
Connection
connection
/ Required
Notes
 
Input
Conversation Id
string
/ Required
Notes
The ID of the conversation
Input
Conversation Link
string
Notes
A URL that can open the conversation in the provider"s side
Input
Created At
string
/ Required
Notes
The date and time when the message was created in the provider, in UTC
Input
Id
string
/ Required
Notes
The ID of the message
Input
Message
string
/ Required
Notes
The body of the message
Input
Reply By
string
Notes
The date and time when the message can no longer receive a reply, in UTC
Input
Sender Id
string
/ Required
Notes
The ID of the provider"s user that sent the message
Input
Status
string
/ Required
Notes
The status of the message

Search Deals#

Search deals | key: searchDeals

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Exact Match
boolean
Default
false
Notes
When enabled, only full exact matches against the given term are returned
Input
Fields
string
Default
Notes
A comma-separated string array
Input
Include Fields
string
Default
Notes
Supports including optional fields in the results which are not provided by default
Input
Limit
string
Default
Notes
Items shown per page
Input
Organization Id
string
Default
Notes
Will filter deals by the provided organization ID
Input
Person Id
string
Default
Notes
Will filter deals by the provided person ID
Input
Start
string
Default
0
Notes
Pagination start
Input
Status
string
Default
Notes
Will filter deals by the provided specific status
Input
Term
string
/ Required
Default
Notes
The search term to look for

Search Item#

Perform a search from multiple item types | key: searchItem

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Exact Match
boolean
Default
false
Notes
When enabled, only full exact matches against the given term are returned
Input
Fields
string
Default
Notes
A comma-separated string array
Input
Include Fields
string
Default
Notes
A comma-separated string array
Input
Item Types
string
Default
Notes
A comma-separated string array
Input
Limit
string
Default
Notes
Items shown per page
Input
Search For Related Items
boolean
Default
false
Notes
When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization
Input
Start
string
Default
0
Notes
Pagination start
Input
Term
string
/ Required
Default
Notes
The search term to look for

Search Item By Field#

Perform a search using a specific field from an item type | key: searchItemByField

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Exact Match
boolean
Default
false
Notes
When enabled, only full exact matches against the given term are returned
Input
Field Key
string
/ Required
Default
Notes
The key of the field to search from
Input
Field Type
string
/ Required
Default
Notes
The type of the field to perform the search from
Input
Limit
string
Default
Notes
Items shown per page
Input
Return Item Ids
boolean
Default
false
Notes
Whether to return the IDs of the matching items or not
Input
Start
string
Default
Notes
Pagination start
Input
Term
string
/ Required
Default
Notes
The search term to look for

Search Leads#

Search leads | key: searchLeads

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Exact Match
boolean
Default
false
Notes
When enabled, only full exact matches against the given term are returned
Input
Fields
string
Default
Notes
A comma-separated string array
Input
Include Fields
string
Default
Notes
Supports including optional fields in the results which are not provided by default
Input
Limit
string
Default
Notes
Items shown per page
Input
Organization Id
string
Default
Notes
Will filter leads by the provided organization ID
Input
Person Id
string
Default
Notes
Will filter leads by the provided person ID
Input
Start
string
Default
0
Notes
Pagination start
Input
Term
string
/ Required
Default
Notes
The search term to look for

Search Organization#

Search organizations | key: searchOrganization

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Exact Match
boolean
Default
false
Notes
When enabled, only full exact matches against the given term are returned
Input
Fields
string
Default
Notes
A comma-separated string array
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start
Input
Term
string
/ Required
Default
Notes
The search term to look for

Search Persons#

Search persons | key: searchPersons

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Exact Match
boolean
Default
false
Notes
When enabled, only full exact matches against the given term are returned
Input
Fields
string
Default
Notes
A comma-separated string array
Input
Include Fields
string
Default
Notes
Supports including optional fields in the results which are not provided by default
Input
Limit
string
Default
Notes
Items shown per page
Input
Organization Id
string
Default
Notes
Will filter persons by the provided organization ID
Input
Start
string
Default
0
Notes
Pagination start
Input
Term
string
/ Required
Default
Notes
The search term to look for

Search Products#

Search products | key: searchProducts

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Exact Match
boolean
Default
false
Notes
When enabled, only full exact matches against the given term are returned
Input
Fields
string
Default
Notes
A comma-separated string array
Input
Include Fields
string
Default
Notes
Supports including optional fields in the results which are not provided by default
Input
Limit
string
Default
Notes
Items shown per page
Input
Start
string
Default
0
Notes
Pagination start
Input
Term
string
/ Required
Default
Notes
The search term to look for

Update Activity#

Update an activity | key: updateActivity

InputDefaultNotes
Input
Attendees
string
Default
Notes
The attendees of the activity
Input
Busy Flag
boolean
Default
false
Notes
Set the activity as "Busy" or "Free"
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Deal Id
string
Default
Notes
The ID of the deal this activity is associated with
Input
Done
string
Default
Notes
Whether the activity is done or not
Input
Due Date
string
Default
Notes
The due date of the activity
Input
Due Time
string
Default
Notes
The due time of the activity in UTC
Input
Duration
string
Default
Notes
The duration of the activity
Input
Id
string
/ Required
Default
Notes
The ID of the activity
Input
Lead Id
string
Default
Notes
The ID of the lead this activity is associated with
Input
Location
string
Default
Notes
The address of the activity
Input
Note
string
Default
Notes
The note of the activity (HTML format)
Input
Org Id
string
Default
Notes
The ID of the organization this activity is associated with
Input
Participants
string
Default
Notes
List of multiple persons (participants) this activity is associated with
Input
Person Id
string
Default
Notes
The ID of the person this activity is associated with
Input
Public Description
string
Default
Notes
Additional details about the activity that is synced to your external calendar
Input
Subject
string
Default
Notes
The subject of the activity
Input
Type
string
Default
Notes
The type of the activity
Input
User Id
string
Default
Notes
The ID of the user whom the activity is assigned to

Update Activity Type#

Update an activity type | key: updateActivityType

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the activity type

Update Comment For Note#

Update a comment related to a note | key: updateCommentForNote

InputNotes
Input
Comment Id
string
/ Required
Notes
The ID of the comment
Input
Connection
connection
/ Required
Notes
 
Input
Content
string
/ Required
Notes
The content of the comment in HTML format
Input
Id
string
/ Required
Notes
The ID of the note

Update Deal#

Update a deal | key: updateDeal

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Currency
string
Notes
The currency of the deal
Input
Expected Close Date
string
Notes
The expected close date of the deal
Input
Id
string
/ Required
Notes
The ID of the deal
Input
Lost Reason
string
Notes
The optional message about why the deal was lost (to be used when status = lost)
Input
Org Id
string
Notes
The ID of an organization which this deal will be linked to
Input
Person Id
string
Notes
The ID of a person which this deal will be linked to
Input
Pipeline Id
string
Notes
The ID of the pipeline this deal will be added to
Input
Probability
string
Notes
The success probability percentage of the deal
Input
Stage Id
string
Notes
The ID of the stage this deal will be added to
Input
Status
string
Notes
open = Open, won = Won, lost = Lost, deleted = Deleted
Input
Title
string
Notes
The title of the deal
Input
User Id
string
Notes
The ID of the user which will be the owner of the created deal
Input
Value
string
Notes
The value of the deal
Input
Visible To
string
Notes
The visibility of the deal

Update Deal Field#

Update a deal field | key: updateDealField

InputDefaultNotes
Input
Add Visible Flag
boolean
Default
true
Notes
Whether the field is available in "add new" modal or not (both in web and mobile app)
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the field
Input
Name
string
Default
Notes
The name of the field
Input
Options
string
Default
Notes
When "field_type" is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects

Update Deal Product#

Update product attachment details of the deal-product (a product already attached to a deal) | key: updateDealProduct

InputDefaultNotes
Input
Comments
string
Default
Notes
Any textual comment associated with this product-deal attachment
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Discount Percentage
string
Default
0
Notes
The discount %
Input
Duration
string
Default
1
Notes
The duration of the product (when product durations are not enabled for the company or if omitted, defaults to 1)
Input
Enabled Flag
string
Default
Notes
Whether the product is enabled on the deal or not
Input
Id
string
/ Required
Default
Notes
The ID of the deal
Input
Item Price
string
/ Required
Default
Notes
The price at which this product will be added to the deal
Input
Product Attachment Id
string
/ Required
Default
Notes
The ID of the deal-product (the ID of the product attached to the deal)
Input
Product Variation Id
string
Default
Notes
The ID of the product variation to use
Input
Quantity
string
/ Required
Default
Notes
Quantity – e
Input
Tax
string
Default
0
Notes
The tax percentage

Update File#

Update file details | key: updateFile

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the file

Update Filter#

Update filter | key: updateFilter

InputNotes
Input
Conditions
string
/ Required
Notes
The conditions of the filter as a JSON object
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the filter
Input
Name
string
Notes
The name of the filter

Update Goal#

Update existing goal | key: updateGoal

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the goal to be updated

Update Lead#

Update a lead | key: updateLead

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Expected Close Date
string
Default
Notes
The date of when the deal which will be created from the lead is expected to be closed
Input
Id
string
/ Required
Default
Notes
The ID of the lead
Input
Is Archived
boolean
Default
false
Notes
A flag indicating whether the lead is archived or not
Input
Label Ids
string
Default
Notes
The IDs of the lead labels which will be associated with the lead
Input
Organization Id
string
Default
Notes
The ID of an organization which this lead will be linked to
Input
Owner Id
string
Default
Notes
The ID of the user which will be the owner of the created lead
Input
Person Id
string
Default
Notes
The ID of a person which this lead will be linked to
Input
Title
string
Default
Notes
The name of the lead
Input
Value
string
Default
Notes
The potential value of the lead
Input
Visible To
string
Default
Notes
The visibility of the lead
Input
Was Seen
boolean
Default
false
Notes
A flag indicating whether the lead was seen by someone in the Pipedrive UI

Update Lead Label#

Update a lead label | key: updateLeadLabel

InputNotes
Input
Color
string
Notes
The color of the label
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the lead label
Input
Name
string
Notes
The name of the lead label

Update Mail Thread Details#

Update mail thread details | key: updateMailThreadDetails

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the mail thread

Update Note#

Update a note | key: updateNote

InputNotes
Input
Add Time
string
Notes
The optional creation date & time of the note in UTC
Input
Connection
connection
/ Required
Notes
 
Input
Content
string
/ Required
Notes
The content of the note in HTML format
Input
Deal Id
string
Notes
The ID of the deal the note will be attached to
Input
Id
string
/ Required
Notes
The ID of the note
Input
Lead Id
string
Notes
The ID of the lead the note will be attached to
Input
Org Id
string
Notes
The ID of the organization the note will be attached to
Input
Person Id
string
Notes
The ID of the person the note will be attached to
Input
Pinned To Deal Flag
string
Notes
If set, the results are filtered by note to deal pinning state ("deal_id" is also required)
Input
Pinned To Lead Flag
string
Notes
If set, the results are filtered by note to lead pinning state ("lead_id" is also required)
Input
Pinned To Organization Flag
string
Notes
If set, the results are filtered by note to organization pinning state ("org_id" is also required)
Input
Pinned To Person Flag
string
Notes
If set, the results are filtered by note to person pinning state ("person_id" is also required)
Input
User Id
string
Notes
The ID of the user who will be marked as the author of the note

Update Organization#

Update an organization | key: updateOrganization

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the organization
Input
Name
string
/ Required
Notes
The name of the organization
Input
Owner Id
string
Notes
The ID of the user who will be marked as the owner of this organization
Input
Visible To
string
Notes
The visibility of the organization

Update Organization Field#

Update an organization field | key: updateOrganizationField

InputDefaultNotes
Input
Add Visible Flag
boolean
Default
true
Notes
Whether the field is available in "add new" modal or not (both in web and mobile app)
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the field
Input
Name
string
Default
Notes
The name of the field
Input
Options
string
Default
Notes
When "field_type" is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects

Update Organization Relationship#

Update an organization relationship | key: updateOrganizationRelationship

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the organization relationship
Input
Org Id
string
Notes
The ID of the base organization for the returned calculated values
Input
Rel Linked Org Id
string
Notes
The linked organization in this relationship
Input
Rel Owner Org Id
string
Notes
The owner of this relationship
Input
Type
string
Notes
The type of organization relationship

Update Person#

Update a person | key: updatePerson

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Email
string
Notes
List of email data related to the person
Input
Id
string
/ Required
Notes
The ID of the person
Input
Marketing Status
string
Notes
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
Input
Name
string
/ Required
Notes
The name of the person
Input
Org Id
string
Notes
The ID of the organization this person will belong to
Input
Owner Id
string
Notes
The ID of the user who will be marked as the owner of this person
Input
Phone
string
Notes
List of phone data related to the person
Input
Visible To
string
Notes
The visibility of the person

Update Person Field#

Update a person field | key: updatePersonField

InputDefaultNotes
Input
Add Visible Flag
boolean
Default
true
Notes
Whether the field is available in "add new" modal or not (both in web and mobile app)
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the field
Input
Name
string
Default
Notes
The name of the field
Input
Options
string
Default
Notes
When "field_type" is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects

Update Pipeline#

Update a pipeline | key: updatePipeline

InputNotes
Input
Active
string
Notes
Whether this pipeline will be made inactive (hidden) or active
Input
Connection
connection
/ Required
Notes
 
Input
Deal Probability
string
Notes
Whether deal probability is disabled or enabled for this pipeline
Input
Id
string
/ Required
Notes
The ID of the pipeline
Input
Name
string
Notes
The name of the pipeline
Input
Order Nr
string
Notes
Defines the order of pipelines

Update Product#

Update a product | key: updateProduct

InputDefaultNotes
Input
Active Flag
string
Default
1
Notes
Whether this product will be made active or not
Input
Code
string
Default
Notes
The product code
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the product
Input
Name
string
Default
Notes
The name of the product
Input
Owner Id
string
Default
Notes
The ID of the user who will be marked as the owner of this product
Input
Prices
string
Default
Notes
An array of objects, each containing: "currency" (string), "price" (number), "cost" (number, optional), "overhead_cost" (number, optional)
Input
Selectable
string
Default
1
Notes
Whether this product can be selected in deals or not
Input
Tax
string
Default
0
Notes
The tax percentage
Input
Unit
string
Default
Notes
The unit in which this product is sold
Input
Visible To
string
Default
Notes
The visibility of the product

Update Product Field#

Update a product field | key: updateProductField

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the product field
Input
Name
string
Notes
The name of the field
Input
Options
string
Notes
When "field_type" is either set or enum, possible options on update must be supplied as an array of objects each containing id and label, for example: [{"id":1, "label":"red"},{"id":2, "label":"blue"},{"id":3, "label":"lilac"}]

Update Recurring Subscription#

Update a recurring subscription | key: updateRecurringSubscription

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Cycle Amount
string
Default
Notes
The amount of each payment
Input
Description
string
Default
Notes
The description of the recurring subscription
Input
Effective Date
string
/ Required
Default
Notes
All payments after that date will be affected
Input
Id
string
/ Required
Default
Notes
The ID of the subscription
Input
Payments
string
Default
Notes
Array of additional payments
Input
Update Deal Value
boolean
Default
false
Notes
Indicates that the deal value must be set to recurring subscription"s MRR value

Update Role#

Update role details | key: updateRole

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the role

Update Stage#

Update stage details | key: updateStage

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Deal Probability
string
Default
Notes
The success probability percentage of the deal
Input
Id
string
/ Required
Default
Notes
The ID of the stage
Input
Name
string
Default
Notes
The name of the stage
Input
Order Nr
string
Default
Notes
An order number for this stage
Input
Pipeline Id
string
Default
Notes
The ID of the pipeline to add stage to
Input
Rotten Days
string
Default
Notes
The number of days the deals not updated in this stage would become rotten
Input
Rotten Flag
boolean
Default
false
Notes
Whether deals in this stage can become rotten

Update Subscription Installment#

Update an installment subscription | key: updateSubscriptionInstallment

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Id
string
/ Required
Default
Notes
The ID of the subscription
Input
Payments
string
/ Required
Default
Notes
Array of payments
Input
Update Deal Value
boolean
Default
false
Notes
Indicates that the deal value must be set to installment subscription"s total value

Update Team#

Update a team | key: updateTeam

InputNotes
Input
Active Flag
string
Notes
Flag that indicates whether the team is active
Input
Connection
connection
/ Required
Notes
 
Input
Deleted Flag
string
Notes
Flag that indicates whether the team is deleted
Input
Description
string
Notes
The team description
Input
Id
string
/ Required
Notes
The ID of the team
Input
Manager Id
string
Notes
The team manager ID
Input
Name
string
Notes
The team name
Input
Users
string
Notes
The IDs of the users that belong to the team

Update User#

Update user details | key: updateUser

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Id
string
/ Required
Notes
The ID of the user