A generated OIH connector for the Pipedrive API v1 API (version 1.0.0).
Generated from: https://developers.pipedrive.com/docs/api/v1/openapi.yaml
Generated at: 2021-10-04T12:13:47+02:00
Supported authorization schemes:
-
API Key
-
OAuth2 - For more information, see https://pipedrive.readme.io/docs/marketplace-oauth-authorization
For OAuth 2.0 you need to specify OAuth Client credentials as environment variables in the connector repository:
OAUTH_CLIENT_ID
- your OAuth client idOAUTH_CLIENT_SECRET
- your OAuth client secret
Marks multiple Activities as deleted
Tags: Activities
ids
- required - Comma-separated IDs of Activities that will be deleted
Adds a new Activity. Includes
more_activities_scheduled_in_context
property in response'sadditional_data
which indicates whether there are more undone Activities scheduled with the same Deal, Person or Organization (depending on the supplied data). For more information on how to add an Activity, see this tutorial.
Tags: Activities
Deletes an Activity
Tags: Activities
id
- required - The ID of the Activity
Returns details of a specific Activity
Tags: Activities
id
- required - The ID of the Activity
Modifies an Activity. Includes
more_activities_scheduled_in_context
property in response'sadditional_data
which indicates whether there are more undone activities scheduled with the same Deal, Person or Organization (depending on the supplied data).
Tags: Activities
id
- required - The ID of the Activity
Marks multiple ActivityTypes as deleted.
Tags: ActivityTypes
ids
- required - Comma-separated ActivityType IDs
Adds a new ActivityType and returns it upon success.
Tags: ActivityTypes
Marks an ActivityType as deleted.
Tags: ActivityTypes
id
- required - The ID of the ActivityType
Updates an ActivityType.
Tags: ActivityTypes
id
- required - The ID of the ActivityType
Adds a new call log
Tags: CallLogs
Deletes a call log. If there is an audio recording attached to it, it will also be deleted. The related activity will not be removed by this request. If you want to remove the related activities, please use the endpoint which is specific for activities.
Tags: CallLogs
id
- required - The ID received when you create the call log
Returns details of a specific call log
Tags: CallLogs
id
- required - The ID received when you create the call log
Adds an audio recording to the call log. That audio can be played by those who have access to the call log object.
Tags: CallLogs
id
- required - The ID received when you create the call log
Adds a new deal. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for
key
values. For more information on how to add a deal, see this tutorial.
Tags: Deals
Marks multiple deals as deleted.
Tags: Deals
ids
- required - Comma-separated IDs that will be deleted
Marks a deal as deleted.
Tags: Deals
id
- required - ID of the deal
Returns details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals - such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the
key
value of dealFields. For more information on how to get all details of a deal, see this tutorial.
Tags: Deals
id
- required - ID of the deal
Updates the properties of a deal. For more information on how to update a deal, see this tutorial.
Tags: Deals
id
- required - ID of the deal
Duplicate a deal
Tags: Deals
id
- required - ID of the deal
Adds a follower to a deal.
Tags: Deals
id
- required - ID of the deal
Deletes a follower from a deal.
Tags: Deals
id
- required - ID of the dealfollower_id
- required - ID of the follower
Merges a deal with another deal. For more information on how to merge two deals, see this tutorial.
Tags: Deals
id
- required - ID of the deal
Adds a participant to a deal.
Tags: Deals
id
- required - ID of the deal
Deletes a participant from a deal.
Tags: Deals
id
- required - ID of the dealdeal_participant_id
- required - ID of the deal participant
Adds a product to the deal.
Tags: Deals
id
- required - ID of the deal
Updates product attachment details.
Tags: Deals
id
- required - ID of the dealproduct_attachment_id
- required - ID of the deal-product (the ID of the product attached to the deal)
Deletes a product attachment from a deal, using the
product_attachment_id
.
Tags: Deals
id
- required - ID of the dealproduct_attachment_id
- required - Product attachment ID. This is returned asproduct_attachment_id
after attaching a product to a deal or as id when listing the products attached to a deal.
Adds a new deal field. For more information on adding a new custom field, see this tutorial.
Tags: DealFields
Marks multiple fields as deleted.
Tags: DealFields
ids
- required - Comma-separated field IDs to delete
Returns data about a specific deal field.
Tags: DealFields
id
- required - ID of the field
Marks a field as deleted. For more information on how to delete a custom field, see this tutorial.
Tags: DealFields
id
- required - ID of the field
Updates a deal field. See an example of updating custom fields' values in this tutorial.
Tags: DealFields
id
- required - ID of the field
Lets you upload a file and associate it with Deal, Person, Organization, Activity or Product. For more information on how to add a file, see this tutorial.
Tags: Files
Creates a new empty file in the remote location (
googledrive
) that will be linked to the item you supply. For more information on how to add a remote file, see this tutorial.
Tags: Files
Links an existing remote file (
googledrive
) to the item you supply. For more information on how to link a remote file, see this tutorial.
Tags: Files
Marks a file as deleted.
Tags: Files
id
- required - ID of the file
Returns data about a specific file.
Tags: Files
id
- required - ID of the file
Updates the properties of a file.
Tags: Files
id
- required - ID of the file
Marks multiple filters as deleted.
Tags: Filters
ids
- required - Comma-separated filter IDs to delete
Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with 'AND', and only two second level condition groups are supported of which one must be glued with 'AND' and the second with 'OR'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information on how to add a new filter, see this tutorial.
Tags: Filters
Marks a filter as deleted.
Tags: Filters
id
- required - The ID of the filter
Returns data about a specific filter. Note that this also returns the condition lines of the filter.
Tags: Filters
id
- required - The ID of the filter
Updates an existing filter.
Tags: Filters
id
- required - The ID of the filter
Removes global message from being shown, if message is dismissible
Tags: GlobalMessages
id
- required - ID of global message to be dismissed.
Adds a new goal. Along with adding a new goal, a report is created to track the progress of your goal.
Tags: Goals
Updates existing goal.
Tags: Goals
id
- required - ID of the goal to be updated.
Marks goal as deleted.
Tags: Goals
id
- required - ID of the goal to be deleted.
Creates a Lead. A Lead always has to be linked to a Person or an Organization or both. All Leads created through the Pipedrive API will have a Lead Source
API
assigned. Here's the tutorial for adding a Lead. If a Lead contains custom fields, the fields' values will be included in the response in the same format as with theDeals
endpoints. If a custom field's value hasn't been set for the Lead, it won't appear in the response. Please note that Leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from Deals. See an example given in the updating custom fields' values tutorial.
Tags: Leads
Returns details of a specific Lead. If a Lead contains custom fields, the fields' values will be included in the response in the same format as with the
Deals
endpoints. If a custom field's value hasn't been set for the Lead, it won't appear in the response. Please note that Leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from Deals.
Tags: Leads
id
- required - The ID of the Lead
Updates one or more properties of a Lead. Only properties included in the request will be updated. Send
null
to unset a property (applicable for example forvalue
,person_id
ororganization_id
). If a Lead contains custom fields, the fields' values will be included in the response in the same format as with theDeals
endpoints. If a custom field's value hasn't been set for the Lead, it won't appear in the response. Please note that Leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from Deals. See an example of updating custom fields' values in this tutorial.
Tags: Leads
id
- required - The ID of the Lead
Deletes a specific Lead
Tags: Leads
id
- required - The ID of the Lead
Creates a Lead Label
Tags: LeadLabels
Updates one or more properties of a Lead Label. Only properties included in the request will be updated.
Tags: LeadLabels
id
- required - The ID of the Lead Label
Deletes a specific Lead Label
Tags: LeadLabels
id
- required - The ID of the Lead Label
Returns data about specific mail message.
Tags: Mailbox
id
- required - ID of the mail message to fetch.include_body
- optional - Whether to include full message body or not.0
= Don't include,1
= Include
Possible values: 0, 1.
Marks mail thread as deleted.
Tags: Mailbox
id
- required - ID of the mail thread
Returns specific mail thread.
Tags: Mailbox
id
- required - ID of the mail thread
Updates the properties of a mail thread.
Tags: Mailbox
id
- required - ID of the mail thread
Adds a new note.
Tags: Notes
Deletes a specific note.
Tags: Notes
id
- required - ID of the note
Returns details about a specific note.
Tags: Notes
id
- required - ID of the note
Updates a note.
Tags: Notes
id
- required - ID of the note
Adds a new comment to a note.
Tags: Notes
id
- required - ID of the note
Returns details about a comment
Tags: Notes
id
- required - ID of the notecommentId
- required - ID of the comment
Updates a comment related to a note.
Tags: Notes
id
- required - ID of the notecommentId
- required - ID of the comment
Deletes a comment.
Tags: Notes
id
- required - ID of the notecommentId
- required - ID of the comment
Marks multiple organizations as deleted.
Tags: Organizations
ids
- required - Comma-separated IDs that will be deleted
Adds a new organization. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the organizationFields and look for
key
values. For more information on how to add an organization, see this tutorial.
Tags: Organizations
Marks an organization as deleted.
Tags: Organizations
id
- required - The ID of the Organization
Returns details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the
key
value of organizationFields.
Tags: Organizations
id
- required - The ID of the Organization
Updates the properties of an organization.
Tags: Organizations
id
- required - The ID of the Organization
Adds a follower to an organization.
Tags: Organizations
id
- required - The ID of the Organization
Deletes a follower from an organization. You can retrieve the
follower_id
from the List followers of an organization endpoint.
Tags: Organizations
id
- required - The ID of the Organizationfollower_id
- required - The ID of the follower
Merges an organization with another organization. For more information on how to merge two organizations, see this tutorial.
Tags: Organizations
id
- required - The ID of the Organization
Adds a new organization field. For more information on adding a new custom field, see this tutorial.
Tags: OrganizationFields
Marks multiple fields as deleted.
Tags: OrganizationFields
ids
- required - Comma-separated field IDs to delete
Returns data about a specific organization field.
Tags: OrganizationFields
id
- required - ID of the field
Marks a field as deleted. For more information on how to delete a custom field, see this tutorial.
Tags: OrganizationFields
id
- required - ID of the field
Updates an organization field. See an example of updating custom fields' values in this tutorial.
Tags: OrganizationFields
id
- required - ID of the field
Creates and returns an organization relationship.
Tags: OrganizationRelationships
Deletes an organization relationship and returns the deleted id.
Tags: OrganizationRelationships
id
- required - ID of the organization relationship
Finds and returns an organization relationship from its ID.
Tags: OrganizationRelationships
id
- required - ID of the organization relationshiporg_id
- optional - ID of the base organization for the returned calculated values
Updates and returns an organization relationship.
Tags: OrganizationRelationships
id
- required - ID of the organization relationship
Tags: PermissionSets
id
- required - ID of the permission set
Marks multiple persons as deleted.
Tags: Persons
ids
- optional - Comma-separated IDs that will be deleted
Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for
key
values.
Tags: Persons
Marks a person as deleted.
Tags: Persons
id
- required - ID of a person
Returns details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the
key
value of personFields.
Tags: Persons
id
- required - ID of a person
Updates the properties of a person. For more information on how to update a person, see this tutorial.
Tags: Persons
id
- required - ID of a person
Adds a follower to a person.
Tags: Persons
id
- required - ID of a person
Delete a follower from a person
Tags: Persons
id
- required - ID of a personfollower_id
- required - ID of the follower
Merges a person with another person. For more information on how to merge two persons, see this tutorial.
Tags: Persons
id
- required - ID of a person
Tags: Persons
id
- required - ID of a person
Add a picture to a person. If a picture is already set, the old picture will be replaced. Added image (or the cropping parameters supplied with the request) should have an equal width and height and should be at least 128 pixels. GIF, JPG and PNG are accepted. All added images will be resized to 128 and 512 pixel wide squares.
Tags: Persons
id
- required - ID of a person
Adds a new person field. For more information on adding a new custom field, see this tutorial.
Tags: PersonFields
Marks multiple fields as deleted.
Tags: PersonFields
ids
- required - Comma-separated field IDs to delete
Returns data about a specific person field.
Tags: PersonFields
id
- required - ID of the field
Marks a field as deleted. For more information on how to delete a custom field, see this tutorial.
Tags: PersonFields
id
- required - ID of the field
Updates a person field. See an example of updating custom fields' values in this tutorial.
Tags: PersonFields
id
- required - ID of the field
Adds a new pipeline
Tags: Pipelines
Marks a pipeline as deleted.
Tags: Pipelines
id
- required - ID of the pipeline
Returns data about a specific pipeline. Also returns the summary of the deals in this pipeline across its stages.
Tags: Pipelines
id
- required - ID of the pipelinetotals_convert_currency
- optional - 3-letter currency code of any of the supported currencies. When supplied,per_stages_converted
is returned indeals_summary
which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter todefault_currency
in which case users default currency is used.
Updates pipeline properties
Tags: Pipelines
id
- required - ID of the pipeline
Adds a new product to the Products inventory. For more information on how to add a product, see this tutorial.
Tags: Products
Marks a product as deleted.
Tags: Products
id
- required - ID of the product
Returns data about a specific product.
Tags: Products
id
- required - ID of the product
Updates product data.
Tags: Products
id
- required - ID of the product
Adds a follower to a product.
Tags: Products
id
- required - ID of the product
Deletes a follower from a product.
Tags: Products
id
- required - ID of the productfollower_id
- required - ID of the follower
Marks multiple fields as deleted.
Tags: ProductFields
ids
- required - Comma-separated field IDs to delete
Adds a new product field. For more information on adding a new custom field, see this tutorial.
Tags: ProductFields
Marks a field as deleted. For more information on how to delete a custom field, see this tutorial.
Tags: ProductFields
id
- required - ID of the Product Field
Returns data about a specific product field.
Tags: ProductFields
id
- required - ID of the Product Field
Updates a product field. See an example of updating custom fields' values in this tutorial.
Tags: ProductFields
id
- required - ID of the Product Field
Tags: Roles
Tags: Roles
id
- required - ID of the role
Tags: Roles
id
- required - ID of the role
Tags: Roles
id
- required - ID of the role
Delete assignment from a role
Tags: Roles
id
- required - ID of the role
Add assignment for a role
Tags: Roles
id
- required - ID of the role
Tags: Roles
id
- required - ID of the role
Marks multiple stages as deleted.
Tags: Stages
ids
- required - Comma-separated stage IDs to delete
Adds a new stage, returns the ID upon success.
Tags: Stages
Marks a stage as deleted.
Tags: Stages
id
- required - ID of the stage
Returns data about a specific stage.
Tags: Stages
id
- required - ID of the stage
Updates the properties of a stage.
Tags: Stages
id
- required - ID of the stage
Returns details of an installment or a recurring Subscription.
Tags: Subscriptions
id
- required - ID of the Subscription
Marks an installment or a recurring Subscription as deleted.
Tags: Subscriptions
id
- required - ID of the Subscription
Returns details of an installment or a recurring Subscription by Deal ID.
Tags: Subscriptions
dealId
- required - ID of the Deal
Adds a new recurring Subscription.
Tags: Subscriptions
Adds a new installment Subscription.
Tags: Subscriptions
Updates a recurring Subscription.
Tags: Subscriptions
id
- required - ID of the Subscription
Updates an installment Subscription.
Tags: Subscriptions
id
- required - ID of the Subscription
Cancels a recurring Subscription.
Tags: Subscriptions
id
- required - ID of the Subscription
Adds a new team to the company and returns the created object
Tags: Teams
Returns data about a specific team
Tags: Teams
id
- required - ID of the teamskip_users
- optional - When enabled, the teams will not include IDs of member users
Possible values: 0, 1.
Updates an existing team and returns the updated object
Tags: Teams
id
- required - ID of the team
Adds users to an existing team
Tags: Teams
id
- required - ID of the team
Deletes users from an existing team
Tags: Teams
id
- required - ID of the team
Returns data about all teams which have specified user as a member
Tags: Teams
id
- required - ID of the userorder_by
- optional - Field name to sort returned teams by
Possible values: id, name, manager_id, active_flag.skip_users
- optional - When enabled, the teams will not include IDs of member users
Possible values: 0, 1.
Adds a new user to the company, returns the ID upon success.
Tags: Users
Returns data about a specific user within the company
Tags: Users
id
- required - ID of the user
Updates the properties of a user. Currently, only
active_flag
can be updated.
Tags: Users
id
- required - ID of the user
Delete a role assignment for a user
Tags: Users
id
- required - ID of the user
Add role assignment for a user
Tags: Users
id
- required - ID of the user
Creates a new webhook and returns its details. Note that specifying an event which triggers the webhook combines 2 parameters -
event_action
andevent_object
. E.g., use*.*
for getting notifications about all events,added.deal
for any newly added deals,deleted.persons
for any deleted persons, etc. See https://pipedrive.readme.io/docs/guide-for-webhooks for more details.
Tags: Webhooks
Deletes the specified webhook.
Tags: Webhooks
id
- required - The ID of the webhook to delete
: pipedrive-component
All files of this connector are licensed under the Apache 2.0 License. For details see the file LICENSE on the toplevel directory.