Pipedrive Component

Manage leads, companies, activities, and more on the Pipedrive platform
Component key: pipedrive#
DescriptionPipedrive is a sales-focused customer relationship management tool. This component allows you to manage leads, companies, activities, and more.
#
Pipedrive Connections#
OAuth 2.0To 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.
Input | Default | Notes |
---|---|---|
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 ActivityAdd an activity | key: addActivity
Input | Default | Notes |
---|---|---|
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 TypeAdd new activity type | key: addActivityType
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Add Call LogAdd a call log | key: addCallLog
Input | Notes |
---|---|
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 FileAttach an audio file to the call log | key: addCallLogAudioFile
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Id string / Required | Notes The ID received when you create the call log | Example 3cde3b05035cae14dcfc172bd8000d08 |
#
Add ChannelAdd a channel | key: addChannel
Input | Default | Notes | Example |
---|---|---|---|
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 DealAdd a deal | key: addDeal
Input | Notes |
---|---|
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 FieldAdd a new deal field | key: addDealField
Input | Default | Notes |
---|---|---|
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 FollowerAdd a follower to a deal | key: addDealFollower
Input | Notes |
---|---|
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 ParticipantAdd a participant to a deal | key: addDealParticipant
Input | Notes |
---|---|
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 ProductAdd a product to the deal, eventually creating a new item called a deal-product | key: addDealProduct
Input | Default | Notes |
---|---|---|
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 FileAdd file | key: addFile
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Add File And Link ItCreate a remote file and link it to an item | key: addFileAndLinkIt
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Add FilterAdd a new filter | key: addFilter
Input | Notes |
---|---|
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 GoalAdd a new goal | key: addGoal
Input | Notes |
---|---|
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 LeadAdd a lead | key: addLead
Input | Default | Notes |
---|---|---|
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 LabelAdd a lead label | key: addLeadLabel
Input | Notes |
---|---|
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 NoteAdd a note | key: addNote
Input | Notes |
---|---|
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 CommentAdd a comment to a note | key: addNoteComment
Input | Notes |
---|---|
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 SettingAdd or update role setting | key: addOrUpdateRoleSetting
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the role |
#
Add OrganizationAdd an organization | key: addOrganization
Input | Notes |
---|---|
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 FieldAdd a new organization field | key: addOrganizationField
Input | Default | Notes |
---|---|---|
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 FollowerAdd a follower to an organization | key: addOrganizationFollower
Input | Notes |
---|---|
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 RelationshipCreate an organization relationship | key: addOrganizationRelationship
Input | Notes |
---|---|
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 PersonAdd a person | key: addPerson
Input | Notes |
---|---|
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 FieldAdd a new person field | key: addPersonField
Input | Default | Notes |
---|---|---|
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 FollowerAdd a follower to a person | key: addPersonFollower
Input | Notes |
---|---|
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 PictureAdd person picture | key: addPersonPicture
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the person |
#
Add PipelineAdd a new pipeline | key: addPipeline
Input | Notes |
---|---|
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 ProductAdd a product | key: addProduct
Input | Default | Notes |
---|---|---|
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 FieldAdd a new product field | key: addProductField
Input | Notes |
---|---|
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 FollowerAdd a follower to a product | key: addProductFollower
Input | Notes |
---|---|
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 SubscriptionAdd a recurring subscription | key: addRecurringSubscription
Input | Default | Notes |
---|---|---|
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 RoleAdd a role | key: addRole
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Add Role AssignmentAdd role assignment | key: addRoleAssignment
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the role |
#
Add StageAdd a new stage | key: addStage
Input | Default | Notes |
---|---|---|
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 InstallmentAdd an installment subscription | key: addSubscriptionInstallment
Input | Default | Notes |
---|---|---|
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 TeamAdd a new team | key: addTeam
Input | Notes |
---|---|
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 UserAdd users to a team | key: addTeamUser
Input | Notes |
---|---|
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 UserAdd a new user | key: addUser
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Add User Role AssignmentAdd role assignment | key: addUserRoleAssignment
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the user |
#
Add WebhookCreate a new Webhook | key: addWebhook
Input | Notes |
---|---|
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 SubscriptionCancel a recurring subscription | key: cancelRecurringSubscription
Input | Notes |
---|---|
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 ActivitiesDelete multiple activities in bulk | key: deleteActivities
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Ids string / Required | Notes The comma-separated IDs of activities that will be deleted |
#
Delete ActivityDelete an activity | key: deleteActivity
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the activity |
#
Delete Activity TypeDelete an activity type | key: deleteActivityType
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the activity type |
#
Delete Activity TypesDelete multiple activity types in bulk | key: deleteActivityTypes
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Ids string / Required | Notes The comma-separated activity type IDs |
#
Delete Call LogDelete a call log | key: deleteCallLog
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Id string / Required | Notes The ID received when you create the call log | Example 3cde3b05035cae14dcfc172bd8000d08 |
#
Delete ChannelDelete a channel | key: deleteChannel
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the channel provided by the integration |
#
Delete CommentDelete a comment related to a note | key: deleteComment
Input | Notes |
---|---|
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 ConversationDelete a conversation | key: deleteConversation
Input | Notes |
---|---|
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 DealDelete a deal | key: deleteDeal
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the deal |
#
Delete Deal FieldDelete a deal field | key: deleteDealField
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the field |
#
Delete Deal FieldsDelete multiple deal fields in bulk | key: deleteDealFields
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Ids string / Required | Notes The comma-separated field IDs to delete |
#
Delete Deal FollowerDelete a follower from a deal | key: deleteDealFollower
Input | Notes |
---|---|
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 ParticipantDelete a participant from a deal | key: deleteDealParticipant
Input | Notes |
---|---|
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 ProductDelete an attached product from a deal | key: deleteDealProduct
Input | Notes |
---|---|
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 DealsDelete multiple deals in bulk | key: deleteDeals
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Ids string / Required | Notes The comma-separated IDs that will be deleted |
#
Delete FileDelete a file | key: deleteFile
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the file |
#
Delete FilterDelete a filter | key: deleteFilter
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the filter |
#
Delete FiltersDelete multiple filters in bulk | key: deleteFilters
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Ids string / Required | Notes The comma-separated filter IDs to delete |
#
Delete Global MessageDismiss a global message | key: deleteGlobalMessage
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the global message to be dismissed |
#
Delete GoalDelete existing goal | key: deleteGoal
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the goal to be deleted |
#
Delete LeadDelete a lead | key: deleteLead
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the lead |
#
Delete Lead LabelDelete a lead label | key: deleteLeadLabel
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the lead label |
#
Delete Mail ThreadDelete mail thread | key: deleteMailThread
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the mail thread |
#
Delete NoteDelete a note | key: deleteNote
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the note |
#
Delete OrganizationDelete an organization | key: deleteOrganization
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the organization |
#
Delete Organization FieldDelete an organization field | key: deleteOrganizationField
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the field |
#
Delete Organization FieldsDelete multiple organization fields in bulk | key: deleteOrganizationFields
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Ids string / Required | Notes The comma-separated field IDs to delete |
#
Delete Organization FollowerDelete a follower from an organization | key: deleteOrganizationFollower
Input | Notes |
---|---|
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 RelationshipDelete an organization relationship | key: deleteOrganizationRelationship
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the organization relationship |
#
Delete OrganizationsDelete multiple organizations in bulk | key: deleteOrganizations
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Ids string / Required | Notes The comma-separated IDs that will be deleted |
#
Delete PersonDelete a person | key: deletePerson
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the person |
#
Delete Person FieldDelete a person field | key: deletePersonField
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the field |
#
Delete Person FieldsDelete multiple person fields in bulk | key: deletePersonFields
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Ids string / Required | Notes The comma-separated field IDs to delete |
#
Delete Person FollowerDelete a follower from a person | key: deletePersonFollower
Input | Notes |
---|---|
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 PictureDelete person picture | key: deletePersonPicture
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the person |
#
Delete PersonsDelete multiple persons in bulk | key: deletePersons
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Ids string / Required | Notes The comma-separated IDs that will be deleted |
#
Delete PipelineDelete a pipeline | key: deletePipeline
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the pipeline |
#
Delete ProductDelete a product | key: deleteProduct
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the product |
#
Delete Product FieldDelete a product field | key: deleteProductField
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the product field |
#
Delete Product FieldsDelete multiple product fields in bulk | key: deleteProductFields
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Ids string / Required | Notes The comma-separated field IDs to delete |
#
Delete Product FollowerDelete a follower from a product | key: deleteProductFollower
Input | Notes |
---|---|
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 RoleDelete a role | key: deleteRole
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the role |
#
Delete Role AssignmentDelete a role assignment | key: deleteRoleAssignment
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the role |
#
Delete StageDelete a stage | key: deleteStage
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the stage |
#
Delete StagesDelete multiple stages in bulk | key: deleteStages
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Ids string / Required | Notes The comma-separated stage IDs to delete |
#
Delete SubscriptionDelete a subscription | key: deleteSubscription
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the subscription |
#
Delete Team UserDelete users from a team | key: deleteTeamUser
Input | Notes |
---|---|
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 AssignmentDelete a role assignment | key: deleteUserRoleAssignment
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the user |
#
Delete WebhookDelete existing Webhook | key: deleteWebhook
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the Webhook to delete |
#
Download FileDownload one file | key: downloadFile
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the file |
#
Duplicate DealDuplicate deal | key: duplicateDeal
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the deal |
#
Find Subscription By DealFind subscription by deal | key: findSubscriptionByDeal
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Deal Id string / Required | Notes The ID of the deal |
#
Find Users By NameFind users by name | key: findUsersByName
Input | Default | Notes |
---|---|---|
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 ActivitiesGet all activities assigned to a particular user | key: getActivities
Input | Notes | Example |
---|---|---|
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 ActivityGet details of an activity | key: getActivity
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the activity |
#
Get Activity FieldsGet all activity fields | key: getActivityFields
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Get Activity TypesGet all activity types | key: getActivityTypes
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Get Call LogGet details of a call log | key: getCallLog
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Id string / Required | Notes The ID received when you create the call log | Example 3cde3b05035cae14dcfc172bd8000d08 |
#
Get CommentGet one comment | key: getComment
Input | Notes |
---|---|
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 AddonsGet all add-ons for a single company | key: getCompanyAddons
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Get CurrenciesGet all supported currencies | key: getCurrencies
Input | Notes |
---|---|
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 UserGet current user data | key: getCurrentUser
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Get DealGet details of a deal | key: getDeal
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the deal |
#
Get Deal ActivitiesList activities associated with a deal | key: getDealActivities
Input | Default | Notes |
---|---|---|
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 FieldGet one deal field | key: getDealField
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the field |
#
Get Deal FieldsGet all deal fields | key: getDealFields
Input | Default | Notes |
---|---|---|
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 FilesList files attached to a deal | key: getDealFiles
Input | Default | Notes |
---|---|---|
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 FollowersList followers of a deal | key: getDealFollowers
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the deal |
#
Get Deal Mail MessagesList mail messages associated with a deal | key: getDealMailMessages
Input | Default | Notes |
---|---|---|
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 ParticipantsList participants of a deal | key: getDealParticipants
Input | Default | Notes |
---|---|---|
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 PersonsList all persons associated with a deal | key: getDealPersons
Input | Default | Notes |
---|---|---|
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 ProductsList products attached to a deal | key: getDealProducts
Input | Default | Notes |
---|---|---|
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 UpdatesList updates about a deal | key: getDealUpdates
Input | Default | Notes |
---|---|---|
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 UsersList permitted users | key: getDealUsers
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the deal |
#
Get DealsGet all deals | key: getDeals
Input | Default | Notes |
---|---|---|
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 SummaryGet deals summary | key: getDealsSummary
Input | Notes |
---|---|
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 TimelineGet deals timeline | key: getDealsTimeline
Input | Notes |
---|---|
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 FileGet one file | key: getFile
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the file |
#
Get FilesGet all files | key: getFiles
Input | Default | Notes |
---|---|---|
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 FilterGet one filter | key: getFilter
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the filter |
#
Get Filter HelpersGet all filter helpers | key: getFilterHelpers
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Get FiltersGet all filters | key: getFilters
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Type string | Notes The types of filters to fetch |
#
Get Global MessagesGet global messages | key: getGlobalMessages
Input | Default | Notes |
---|---|---|
Input Connection connection / Required | Default | Notes |
Input Limit string | Default 1 | Notes The number of messages to get from 1 to 100 |
#
Get Goal ResultGet result of a goal | key: getGoalResult
Input | Notes |
---|---|
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 GoalsFind goals | key: getGoals
Input | Default | Notes |
---|---|---|
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 LeadGet one lead | key: getLead
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the lead |
#
Get Lead LabelsGet all lead labels | key: getLeadLabels
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Get Lead SourcesGet all lead sources | key: getLeadSources
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Get LeadsGet all leads | key: getLeads
Input | Notes | Example |
---|---|---|
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 MessageGet one mail message | key: getMailMessage
Input | Default | Notes |
---|---|---|
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 ThreadGet one mail thread | key: getMailThread
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the mail thread |
#
Get Mail Thread MessagesGet all mail messages of mail thread | key: getMailThreadMessages
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the mail thread |
#
Get Mail ThreadsGet mail threads | key: getMailThreads
Input | Default | Notes |
---|---|---|
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 NoteGet one note | key: getNote
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the note |
#
Get Note CommentsGet all comments for a note | key: getNoteComments
Input | Default | Notes |
---|---|---|
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 FieldsGet all note fields | key: getNoteFields
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Get NotesGet all notes | key: getNotes
Input | Default | Notes |
---|---|---|
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 OrganizationGet details of an organization | key: getOrganization
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the organization |
#
Get Organization ActivitiesList activities associated with an organization | key: getOrganizationActivities
Input | Default | Notes |
---|---|---|
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 DealsList deals associated with an organization | key: getOrganizationDeals
Input | Default | Notes |
---|---|---|
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 FieldGet one organization field | key: getOrganizationField
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the field |
#
Get Organization FieldsGet all organization fields | key: getOrganizationFields
Input | Default | Notes |
---|---|---|
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 FilesList files attached to an organization | key: getOrganizationFiles
Input | Default | Notes |
---|---|---|
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 FollowersList followers of an organization | key: getOrganizationFollowers
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the organization |
#
Get Organization Mail MessagesList mail messages associated with an organization | key: getOrganizationMailMessages
Input | Default | Notes |
---|---|---|
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 PersonsList persons of an organization | key: getOrganizationPersons
Input | Default | Notes |
---|---|---|
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 RelationshipGet one organization relationship | key: getOrganizationRelationship
Input | Notes |
---|---|
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 RelationshipsGet all relationships for organization | key: getOrganizationRelationships
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Org Id string / Required | Notes The ID of the organization to get relationships for |
#
Get Organization UpdatesList updates about an organization | key: getOrganizationUpdates
Input | Default | Notes |
---|---|---|
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 UsersList permitted users | key: getOrganizationUsers
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the organization |
#
Get OrganizationsGet all organizations | key: getOrganizations
Input | Default | Notes |
---|---|---|
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 SetGet one permission set | key: getPermissionSet
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the permission set |
#
Get Permission Set AssignmentsList permission set assignments | key: getPermissionSetAssignments
Input | Default | Notes |
---|---|---|
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 SetsGet all permission sets | key: getPermissionSets
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Get PersonGet details of a person | key: getPerson
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the person |
#
Get Person ActivitiesList activities associated with a person | key: getPersonActivities
Input | Default | Notes |
---|---|---|
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 DealsList deals associated with a person | key: getPersonDeals
Input | Default | Notes |
---|---|---|
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 FieldGet one person field | key: getPersonField
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the field |
#
Get Person FieldsGet all person fields | key: getPersonFields
Input | Default | Notes |
---|---|---|
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 FilesList files attached to a person | key: getPersonFiles
Input | Default | Notes |
---|---|---|
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 FollowersList followers of a person | key: getPersonFollowers
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the person |
#
Get Person Mail MessagesList mail messages associated with a person | key: getPersonMailMessages
Input | Default | Notes |
---|---|---|
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 ProductsList products associated with a person | key: getPersonProducts
Input | Default | Notes |
---|---|---|
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 UpdatesList updates about a person | key: getPersonUpdates
Input | Default | Notes |
---|---|---|
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 UsersList permitted users | key: getPersonUsers
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the person |
#
Get PersonsGet all persons | key: getPersons
Input | Default | Notes |
---|---|---|
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 PipelineGet one pipeline | key: getPipeline
Input | Notes |
---|---|
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 StatisticsGet deals conversion rates in pipeline | key: getPipelineConversionStatistics
Input | Notes |
---|---|
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 DealsGet deals in a pipeline | key: getPipelineDeals
Input | Default | Notes |
---|---|---|
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 StatisticsGet deals movements in pipeline | key: getPipelineMovementStatistics
Input | Notes |
---|---|
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 PipelinesGet all pipelines | key: getPipelines
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Get ProductGet one product | key: getProduct
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the product |
#
Get Product DealsGet deals where a product is attached to | key: getProductDeals
Input | Default | Notes |
---|---|---|
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 FieldGet one product field | key: getProductField
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the product field |
#
Get Product FieldsGet all product fields | key: getProductFields
Input | Default | Notes |
---|---|---|
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 FilesList files attached to a product | key: getProductFiles
Input | Default | Notes |
---|---|---|
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 FollowersList followers of a product | key: getProductFollowers
Input | Default | Notes |
---|---|---|
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 UsersList permitted users | key: getProductUsers
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the product |
#
Get ProductsGet all products | key: getProducts
Input | Default | Notes |
---|---|---|
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 RecentsGet recents | key: getRecents
Input | Default | Notes |
---|---|---|
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 RoleGet one role | key: getRole
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the role |
#
Get Role AssignmentsList role assignments | key: getRoleAssignments
Input | Default | Notes |
---|---|---|
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 SettingsList role settings | key: getRoleSettings
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the role |
#
Get Role Sub RolesList role sub-roles | key: getRoleSubRoles
Input | Default | Notes |
---|---|---|
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 RolesGet all roles | key: getRoles
Input | Default | Notes |
---|---|---|
Input Connection connection / Required | Default | Notes |
Input Limit string | Default | Notes Items shown per page |
Input Start string | Default 0 | Notes Pagination start |
#
Get StageGet one stage | key: getStage
Input | Notes |
---|---|
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 DealsGet deals in a stage | key: getStageDeals
Input | Default | Notes |
---|---|---|
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 StagesGet all stages | key: getStages
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Pipeline Id string | Notes The ID of the pipeline to fetch stages for |
#
Get SubscriptionGet details of a subscription | key: getSubscription
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the subscription |
#
Get Subscription PaymentsGet all payments of a subscription | key: getSubscriptionPayments
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the subscription |
#
Get TeamGet a single team | key: getTeam
Input | Default | Notes |
---|---|---|
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 UsersGet all users in a team | key: getTeamUsers
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the team |
#
Get TeamsGet all teams | key: getTeams
Input | Default | Notes |
---|---|---|
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 UserGet one user | key: getUser
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the user |
#
Get User Call LogsGet all call logs assigned to a particular user | key: getUserCallLogs
Input | Default | Notes |
---|---|---|
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 ConnectionsGet all user connections | key: getUserConnections
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Get User FollowersList followers of a user | key: getUserFollowers
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the user |
#
Get User PermissionsList user permissions | key: getUserPermissions
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the user |
#
Get User Role AssignmentsList role assignments | key: getUserRoleAssignments
Input | Default | Notes |
---|---|---|
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 SettingsList user role settings | key: getUserRoleSettings
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the user |
#
Get User SettingsList settings of an authorized user | key: getUserSettings
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Get User TeamsGet all teams of a user | key: getUserTeams
Input | Default | Notes |
---|---|---|
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 UsersGet all users | key: getUsers
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Get WebhooksGet all Webhooks | key: getWebhooks
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Link File To ItemLink a remote file to an item | key: linkFileToItem
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Merge DealsMerge two deals | key: mergeDeals
Input | Notes |
---|---|
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 OrganizationsMerge two organizations | key: mergeOrganizations
Input | Notes |
---|---|
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 PersonsMerge two persons | key: mergePersons
Input | Notes |
---|---|
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 RequestIssue a raw HTTP request | key: rawRequest
Input | Default | Notes | Example |
---|---|---|---|
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 MessageReceives an incoming message | key: receiveMessage
Input | Notes |
---|---|
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 DealsSearch deals | key: searchDeals
Input | Default | Notes |
---|---|---|
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 ItemPerform a search from multiple item types | key: searchItem
Input | Default | Notes |
---|---|---|
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 FieldPerform a search using a specific field from an item type | key: searchItemByField
Input | Default | Notes |
---|---|---|
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 LeadsSearch leads | key: searchLeads
Input | Default | Notes |
---|---|---|
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 OrganizationSearch organizations | key: searchOrganization
Input | Default | Notes |
---|---|---|
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 PersonsSearch persons | key: searchPersons
Input | Default | Notes |
---|---|---|
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 ProductsSearch products | key: searchProducts
Input | Default | Notes |
---|---|---|
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 ActivityUpdate an activity | key: updateActivity
Input | Default | Notes |
---|---|---|
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 TypeUpdate an activity type | key: updateActivityType
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the activity type |
#
Update Comment For NoteUpdate a comment related to a note | key: updateCommentForNote
Input | Notes |
---|---|
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 DealUpdate a deal | key: updateDeal
Input | Notes |
---|---|
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 FieldUpdate a deal field | key: updateDealField
Input | Default | Notes |
---|---|---|
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 ProductUpdate product attachment details of the deal-product (a product already attached to a deal) | key: updateDealProduct
Input | Default | Notes |
---|---|---|
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 FileUpdate file details | key: updateFile
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the file |
#
Update FilterUpdate filter | key: updateFilter
Input | Notes |
---|---|
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 GoalUpdate existing goal | key: updateGoal
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the goal to be updated |
#
Update LeadUpdate a lead | key: updateLead
Input | Default | Notes |
---|---|---|
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 LabelUpdate a lead label | key: updateLeadLabel
Input | Notes |
---|---|
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 DetailsUpdate mail thread details | key: updateMailThreadDetails
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the mail thread |
#
Update NoteUpdate a note | key: updateNote
Input | Notes |
---|---|
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 OrganizationUpdate an organization | key: updateOrganization
Input | Notes |
---|---|
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 FieldUpdate an organization field | key: updateOrganizationField
Input | Default | Notes |
---|---|---|
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 RelationshipUpdate an organization relationship | key: updateOrganizationRelationship
Input | Notes |
---|---|
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 PersonUpdate a person | key: updatePerson
Input | Notes |
---|---|
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 FieldUpdate a person field | key: updatePersonField
Input | Default | Notes |
---|---|---|
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 PipelineUpdate a pipeline | key: updatePipeline
Input | Notes |
---|---|
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 ProductUpdate a product | key: updateProduct
Input | Default | Notes |
---|---|---|
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 FieldUpdate a product field | key: updateProductField
Input | Notes |
---|---|
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 SubscriptionUpdate a recurring subscription | key: updateRecurringSubscription
Input | Default | Notes |
---|---|---|
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 RoleUpdate role details | key: updateRole
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the role |
#
Update StageUpdate stage details | key: updateStage
Input | Default | Notes |
---|---|---|
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 InstallmentUpdate an installment subscription | key: updateSubscriptionInstallment
Input | Default | Notes |
---|---|---|
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 TeamUpdate a team | key: updateTeam
Input | Notes |
---|---|
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 UserUpdate user details | key: updateUser
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
Input Id string / Required | Notes The ID of the user |