Pipedrive API Integration Vol.2

These are the list of integration use cases supported by Knit for Pipedrive API as part of the CRM category

Update a product

ID: patch_update_product
Operation: write
Entities: custom field, price, product
Summary: The 'Update a product' API allows users to update the details of a product in the Pipedrive system. The API requires the product ID as a path parameter. The request body can include various optional fields such as name, code, description, unit, tax, category, owner_id, is_linkable, visible_to, prices, billing_frequency, and billing_frequency_cycles. The response returns a success status and the updated product data, including fields like id, name, code, description, unit, tax, category, is_linkable, is_deleted, visible_to, owner_id, add_time, update_time, billing_frequency, billing_frequency_cycles, prices, and custom_fields.
Input Fields: Input Fields
Output Fields: Output Fields

Update the product attached to a deal

ID: patch_update_product_attached_to_deal
Operation: write
Entities: deal, product attachment, product
Summary: This API updates the details of a product attached to a deal in Pipedrive. It requires the deal ID and the product attachment ID as path parameters. The request body can include various optional parameters such as product_id, item_price, quantity, tax, comments, discount, is_enabled, tax_method, discount_type, product_variation_id, billing_frequency, billing_frequency_cycles, and billing_start_date. The response includes a success flag and the updated product details, including id, sum, tax, deal_id, name, product_id, product_variation_id, add_time, update_time, comments, currency, discount, quantity, item_price, tax_method, discount_type, is_enabled, billing_frequency, billing_frequency_cycles, and billing_start_date.
Input Fields: Input Fields
Output Fields: Output Fields

Update a product variation

ID: patch_update_product_variation
Operation: write
Entities: product variation, price, product
Summary: This API updates the data of a specific product variation. It requires the product ID and the product variation ID as path parameters. The request body can include the name of the product variation and an array of price objects, each containing currency, price, cost, and notes. The response indicates success and returns the updated product variation data, including its ID, name, product ID, and prices.
Input Fields: Input Fields
Output Fields: Output Fields

Update stage details

ID: patch_update_stage_details
Operation: write
Entities: deal, stage, pipeline
Summary: The 'Update stage details' API allows users to update the properties of a specific stage in Pipedrive. The API requires the stage ID as a path parameter. Optional body parameters include the stage name, pipeline ID, deal probability, whether deals can become rotten, and the number of days before deals become rotten. The response includes the updated stage details, such as ID, order number, name, deletion status, deal probability, pipeline ID, rot status, days to rot, and timestamps for when the stage was added and last updated.
Input Fields: Input Fields
Output Fields: Output Fields

Add a call log

ID: post_add_a_call_log
Operation: write
Entities: user, activity, call log
Summary: This API endpoint allows you to add a new call log to the Pipedrive system. The request requires a POST method to the endpoint 'https://api.pipedrive.com/v1/callLogs'. The body of the request can include various parameters such as 'user_id', 'activity_id', 'subject', 'duration', 'outcome', 'from_phone_number', 'to_phone_number', 'start_time', 'end_time', 'person_id', 'org_id', 'deal_id', 'lead_id', and 'note'. Among these, 'outcome', 'to_phone_number', 'start_time', and 'end_time' are required fields. The response will indicate success and provide details of the created call log, including its ID, associated activity, person, organization, deal, and other relevant information.
Input Fields: Input Fields
Output Fields: Output Fields

Add a channel

ID: post_add_a_channel
Operation: write
Entities: channel, participant, conversation
Summary: The 'Add a channel' API allows administrators to register a new messaging channel. This endpoint requires the Messengers integration OAuth scope and a ready Messaging manifest for the Messaging app extension. The request body must include the 'name' and 'provider_channel_id' as required fields. Optional fields include 'avatar_url', 'template_support', and 'provider_type', which defaults to 'other'. The response returns a success status and data about the newly created channel, including its ID, name, avatar URL, provider channel ID, marketplace client ID, Pipedrive company and user IDs, creation timestamp, provider type, and template support status.
Input Fields: Input Fields
Output Fields: Output Fields

Add a deal

ID: post_add_a_deal
Operation: write
Entities: deal, custom field, pipeline
Summary: The 'Add a deal' API endpoint allows users to create a new deal in the Pipedrive system. The request must include the 'title' of the deal as a required parameter. Other optional parameters include 'owner_id', 'person_id', 'org_id', 'pipeline_id', 'stage_id', 'value', 'currency', 'add_time', 'update_time', 'stage_change_time', 'is_deleted', 'status', 'probability', 'lost_reason', 'visible_to', 'close_time', 'won_time', 'lost_time', 'expected_close_date', and 'label_ids'. The response returns a success status and the details of the created deal, including its ID, title, owner, value, and other attributes.
Input Fields: Input Fields
Output Fields: Output Fields

Add a lead

ID: post_add_a_lead
Operation: write
Entities: lead, organization, person
Summary: The 'Add a lead' API endpoint allows users to create a new lead in Pipedrive. A lead must be linked to either a person or an organization, or both. The API automatically sets the lead source and origin to 'API'. Custom fields from deals can be included in the lead, and if not set, they won't appear in the response. The request requires a title for the lead and optionally accepts parameters such as owner_id, label_ids, person_id, organization_id, value, expected_close_date, visible_to, was_seen, origin_id, channel, and channel_id. The response includes details about the created lead, such as its ID, title, owner, labels, linked person or organization, source, origin, channel, visibility, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Add a lead label

ID: post_add_a_lead_label
Operation: write
Entities: lead label
Summary: The 'Add a lead label' API allows users to create a new lead label in the Pipedrive system. It requires a POST request to the endpoint 'https://api.pipedrive.com/v1/leadLabels'. The request body must include the 'name' and 'color' of the lead label, both of which are required fields. The 'color' must be one of the predefined values: green, blue, red, yellow, purple, or gray. Upon successful creation, the API returns a response indicating success and provides details of the newly created lead label, including its ID, name, color, and timestamps for when it was added and last updated.
Input Fields: Input Fields
Output Fields: Output Fields

Add a new filter

ID: post_add_a_new_filter
Operation: write
Entities: type, condition, filter
Summary: The 'Add a new filter' API allows users to create a new filter in Pipedrive. It requires a POST request to the endpoint 'https://api.pipedrive.com/v1/filters'. The request must include headers for 'Content-Type' and 'Authorization'. The body of the request must contain the 'name' of the filter, the 'conditions' as a JSON object, and the 'type' of filter to create. The conditions object supports a specific structure with 'AND' and 'OR' glues. Upon success, the API returns a JSON response with the 'success' status and 'data' containing details of the newly created filter, including its 'id', 'name', 'type', and 'conditions'.
Input Fields: Input Fields
Output Fields: Output Fields

Add a new team

ID: post_add_a_new_team
Operation: write
Entities: user, team, manager
Summary: This API adds a new team to the company and returns the created team object. The request requires a POST method to the endpoint 'https://api.pipedrive.com/v1/legacyTeams'. The request body must include the 'name' (string) and 'manager_id' (integer) as required fields, and optionally 'description' (string) and 'users' (array of integers). The response includes a success flag and the data of the created team, such as 'id', 'name', 'description', 'manager_id', 'users', 'active_flag', 'deleted_flag', 'add_time', and 'created_by_user_id'.
Input Fields: Input Fields
Output Fields: Output Fields

Add a new user

ID: post_add_a_new_user
Operation: write
Entities: user, access, permission set
Summary: The 'Add a new user' API allows you to add a new user to the company. It requires the user's email as a mandatory field in the request body. Optionally, you can specify the access permissions for different apps and whether the user is active. The API returns a success flag and the details of the newly created user, including their ID, name, email, access permissions, and other metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Add a note

ID: post_add_a_note
Operation: write
Entities: lead, deal, note
Summary: This API adds a new note to Pipedrive. The request requires a POST method to the endpoint https://api.pipedrive.com/v1/notes. The body of the request must include the 'content' parameter, which is the HTML content of the note. Additionally, one of 'lead_id', 'deal_id', 'person_id', or 'org_id' must be specified to attach the note to a specific entity. Optional parameters include 'user_id', 'add_time', and pinning flags such as 'pinned_to_lead_flag'. The response returns a success status and the details of the created note, including its ID, content, associated entities, and user information.
Input Fields: Input Fields
Output Fields: Output Fields

Add a person

ID: post_add_a_person
Operation: write
Entities: person, organization, user
Summary: The 'Add a person' API allows you to add a new person to the Pipedrive system. You can provide various details about the person, including their name, owner ID, organization ID, email, phone, label, visibility, marketing status, and creation time. The API accepts custom fields specific to each Pipedrive account, which can be identified by long hashes as keys. The response includes detailed information about the newly created person, such as their ID, company ID, owner details, organization details, contact information, activity counts, and more. If the company uses the Campaigns product, the API also handles the 'marketing_status' field.
Input Fields: Input Fields
Output Fields: Output Fields

Add a product

ID: post_add_a_product
Operation: write
Entities: user, price, product
Summary: This API adds a new product to the Products inventory in Pipedrive. It requires a POST request to the endpoint 'https://api.pipedrive.com/api/v2/products'. The request body must include the 'name' of the product, and can optionally include other details such as 'code', 'description', 'unit', 'tax', 'category', 'owner_id', 'is_linkable', 'visible_to', 'prices', 'billing_frequency', and 'billing_frequency_cycles'. The response returns a success status and the details of the newly added product, including its 'id', 'name', 'code', 'description', 'unit', 'tax', 'category', 'is_linkable', 'is_deleted', 'visible_to', 'owner_id', 'add_time', 'update_time', 'billing_frequency', 'billing_frequency_cycles', 'prices', and 'custom_fields'.
Input Fields: Input Fields
Output Fields: Output Fields

Add a project

ID: post_add_a_project
Operation: write
Entities: project, deal, organization
Summary: The 'Add a project' API allows users to create a new project in Pipedrive. It requires the title, board_id, and phase_id as mandatory fields in the request body. Optional fields include description, status, owner_id, start_date, end_date, deal_ids, org_id, person_id, labels, and template_id. The response returns a success status and the details of the created project, including its ID, title, description, status, and associated IDs for deals, persons, and organizations.
Input Fields: Input Fields
Output Fields: Output Fields

Add a role

ID: post_add_a_role
Operation: write
Entities: role
Summary: This API adds a new role in the Pipedrive system. It requires a POST request to the endpoint 'https://api.pipedrive.com/v1/roles'. The request body must include the 'name' parameter, which is a string representing the name of the role and is required. Optionally, it can include 'parent_role_id', an integer representing the ID of the parent role. The response will indicate success with a boolean and provide the ID of the newly created role.
Input Fields: Input Fields
Output Fields: Output Fields

Add a task

ID: post_add_a_task
Operation: write
Entities: user, task, project
Summary: This API adds a new task to the Pipedrive system. It requires the title and project_id as mandatory fields in the request body. Optional fields include description, parent_task_id, assignee_id, done status, and due_date. The response includes the success status, task details such as id, title, creator_id, description, done status, due_date, parent_task_id, assignee_id, add_time, update_time, marked_as_done_time, and project_id.
Input Fields: Input Fields
Output Fields: Output Fields

Add an activity

ID: post_add_activity
Operation: write
Entities: deal, activity, person
Summary: The 'Add an activity' API allows users to create a new activity in Pipedrive. The API requires a POST request to the endpoint 'https://api.pipedrive.com/v1/activities'. The request must include an authorization header with a bearer token. The body of the request can include various parameters such as 'due_date', 'due_time', 'duration', 'deal_id', 'lead_id', 'person_id', 'project_id', 'org_id', 'location', 'public_description', 'note', 'subject', 'type', 'user_id', 'participants', 'busy_flag', 'attendees', and 'done'. The response will include details of the created activity, including its ID, type, due date, and other related information. The response also contains additional data indicating whether there are more undone activities scheduled with the same deal, person, or organization.
Input Fields: Input Fields
Output Fields: Output Fields

Add a comment to a note

ID: post_add_comment_to_note
Operation: write
Entities: user, comment, note
Summary: This API adds a new comment to a specified note. It requires the note ID as a path parameter and the content of the comment in HTML format as a body parameter. The response includes a success flag and data about the newly created comment, such as its unique identifier, content, associated object ID and type, and timestamps for when it was added and last updated.
Input Fields: Input Fields
Output Fields: Output Fields

Add a discount to a deal

ID: post_add_discount_to_deal
Operation: write
Entities: discount, deal, product
Summary: This API adds a discount to a deal, modifying the deal value if the deal has one-time products attached. It requires the deal ID as a path parameter and a request body containing the discount description, amount, and type (either 'percentage' or 'amount'). The response includes a success flag and details of the discount applied, such as its ID, description, amount, type, associated deal ID, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Add file

ID: post_add_file
Operation: write
Entities: person, file, deal
Summary: The 'Add file' API allows you to upload a file and associate it with various entities such as a deal, person, organization, activity, product, or lead in Pipedrive. The request requires a file to be uploaded in multipart/form-data encoding. You can optionally associate the file with a specific deal, person, organization, product, activity, or lead by providing their respective IDs. The response returns a success status and detailed information about the uploaded file, including its ID, associated entity IDs, file name, type, size, and download URL.
Input Fields: Input Fields
Output Fields: Output Fields

Add a follower to a deal

ID: post_add_follower_to_deal
Operation: write
Entities: follower, deal, user
Summary: This API adds a follower to a specific deal in Pipedrive. It requires the deal ID as a path parameter and the user ID as a body parameter. The response indicates whether the operation was successful and includes details about the follower entry, such as the user ID, follower entry ID, deal ID, and the time the follower was added.
Input Fields: Input Fields
Output Fields: Output Fields

Add a follower to an organization

ID: post_add_follower_to_organization
Operation: write
Entities: follower, organization, user
Summary: This API adds a follower to an organization. It requires the organization ID as a path parameter and the user ID as a body parameter. The response indicates whether the operation was successful and provides details about the follower entry, including the user ID, follower entry ID, organization ID, and the time the follower was added.
Input Fields: Input Fields
Output Fields: Output Fields

Add a follower to a person

ID: post_add_follower_to_person
Operation: write
Entities: follower, user, person
Summary: This API adds a follower to a person in the Pipedrive system. It requires the ID of the person as a path parameter and the ID of the user to be added as a follower in the request body. The response includes a success flag and details of the follower entry, such as the user ID, follower entry ID, person ID, and the time the follower was added.
Input Fields: Input Fields
Output Fields: Output Fields

Add a follower to a product

ID: post_add_follower_to_product
Operation: write
Entities: follower, user, product
Summary: This API adds a follower to a product in Pipedrive. It requires the product ID as a path parameter and the user ID as a body parameter. The response indicates whether the operation was successful and includes details about the follower entry, such as the user ID, follower entry ID, product ID, and the time the follower was added.
Input Fields: Input Fields
Output Fields: Output Fields

Add an installment subscription

ID: post_add_installment_subscription
Operation: write
Entities: installment subscription, deal, payment
Summary: This API adds a new installment subscription to a specified deal. It requires the deal ID, currency, and an array of payments as input. The payments array should contain objects with amount, description, and due date. Optionally, you can specify if the deal value should be updated to the total value of the installment subscription. The response includes details of the created subscription, such as its ID, user ID, deal ID, status, currency, start and end dates, description, and lifetime value.
Input Fields: Input Fields
Output Fields: Output Fields

Add new activity type

ID: post_add_new_activity_type
Operation: write
Entities: activity type, icon, color
Summary: This API adds a new activity type to the Pipedrive system. It requires the 'name' and 'icon_key' as mandatory fields in the request body. The 'color' field is optional and should be in 6-character HEX format. The response includes a success flag and details of the newly created activity type, such as its ID, name, icon key, and other attributes.
Input Fields: Input Fields
Output Fields: Output Fields

Add a new deal field

ID: post_add_new_deal_field
Operation: write
Entities: option, deal field
Summary: This API adds a new deal field to the Pipedrive system. It requires the 'name' and 'field_type' as mandatory fields in the request body. The 'options' parameter is needed when the 'field_type' is either 'set' or 'enum'. The 'add_visible_flag' is optional and determines if the field is visible in the 'add new' modal. The response includes a success flag and detailed information about the newly created deal field, including its ID, key, name, type, and various visibility and edit flags.
Input Fields: Input Fields
Output Fields: Output Fields

Add a new goal

ID: post_add_new_goal
Operation: write
Entities: report, goal, assignee
Summary: This API endpoint allows you to add a new goal in Pipedrive. When a new goal is added, a report is also created to track its progress. The request body requires several parameters: 'title' (the title of the goal), 'assignee' (an object specifying who the goal is assigned to, with 'id' and 'type'), 'type' (an object specifying the type of the goal and its parameters), 'expected_outcome' (an object specifying the target and tracking metric), 'duration' (an object specifying the start and end dates), and 'interval' (the interval of the goal, such as weekly or monthly). The response includes a success status, status code, status text, service name, and data about the created goal, including its ID, owner ID, title, type, assignee, interval, duration, expected outcome, active status, and report IDs.
Input Fields: Input Fields
Output Fields: Output Fields

Add a new organization field

ID: post_add_new_organization_field
Operation: write
Entities: organization, field
Summary: This API adds a new organization field in Pipedrive. It requires the 'name' and 'field_type' as mandatory parameters in the request body. The 'options' parameter is needed when the 'field_type' is either 'set' or 'enum'. The 'add_visible_flag' is optional and defaults to true. The response includes a success flag and details of the newly created field, such as its ID, key, name, type, and other attributes.
Input Fields: Input Fields
Output Fields: Output Fields

Add a new person field

ID: post_add_new_person_field
Operation: write
Entities: field type, option, person field
Summary: This API adds a new person field to the Pipedrive system. It requires the 'name' and 'field_type' as mandatory fields in the request body. The 'options' parameter is required when the 'field_type' is either 'set' or 'enum'. The 'add_visible_flag' is optional and defaults to true. The response includes details about the newly created field, such as its ID, key, name, type, and various flags indicating its properties and visibility.
Input Fields: Input Fields
Output Fields: Output Fields

Add a new pipeline

ID: post_add_new_pipeline
Operation: write
Entities: probability, deal, pipeline
Summary: This API adds a new pipeline to the Pipedrive system. It requires a POST request to the endpoint 'https://api.pipedrive.com/api/v2/pipelines'. The request body must include the 'name' parameter, which is a string representing the name of the pipeline. Optionally, the 'is_deal_probability_enabled' parameter can be included to specify whether deal probability is enabled for the pipeline. The response will indicate success and provide details of the newly created pipeline, including its ID, name, order number, and other attributes.
Input Fields: Input Fields
Output Fields: Output Fields

Add a new product field

ID: post_add_new_product_field
Operation: write
Entities: user, product field, option
Summary: This API allows you to add a new product field in Pipedrive. It requires a POST request to the endpoint 'https://api.pipedrive.com/v1/productFields'. The request body must include the 'name' and 'field_type' of the field, with 'field_type' being one of the specified types such as 'varchar', 'enum', etc. If the 'field_type' is 'set' or 'enum', an 'options' array must be provided. The response includes details of the created field, such as its ID, name, type, and other attributes.
Input Fields: Input Fields
Output Fields: Output Fields

Add a new stage

ID: post_add_new_stage
Operation: write
Entities: deal, stage, pipeline
Summary: The 'Add a new stage' API allows users to add a new stage to a specified pipeline in Pipedrive. The API requires the 'name' and 'pipeline_id' as mandatory fields in the request body. Optional fields include 'deal_probability', 'is_deal_rot_enabled', and 'days_to_rotten'. Upon successful creation, the API returns a response containing the 'id' of the newly created stage, along with other details such as 'order_nr', 'name', 'is_deleted', 'deal_probability', 'pipeline_id', 'is_deal_rot_enabled', 'days_to_rotten', 'add_time', and 'update_time'.
Input Fields: Input Fields
Output Fields: Output Fields

Add or update role setting

ID: post_add_or_update_role_setting
Operation: write
Entities: visibility, setting, role
Summary: This API adds or updates the visibility setting for a role in Pipedrive. It requires the role ID as a path parameter and a request body containing the setting_key and value. The setting_key specifies which visibility setting to update, and the value specifies the visibility level. The response indicates whether the operation was successful and returns the updated role ID and visibility setting.
Input Fields: Input Fields
Output Fields: Output Fields

Add an organization

ID: post_add_organization
Operation: write
Entities: user, label, organization
Summary: This API endpoint allows you to add a new organization to Pipedrive. You can provide the organization's name, optional creation time, owner ID, label, label IDs, and visibility settings. The response includes the success status and detailed information about the newly created organization, such as its ID, owner details, deal counts, activity counts, and address information. Custom fields can also be included in the request, which are unique to each Pipedrive account.
Input Fields: Input Fields
Output Fields: Output Fields

Add a participant to a deal

ID: post_add_participant_to_deal
Operation: write
Entities: person, deal, participant
Summary: This API adds a participant to a specific deal in Pipedrive. The request requires the deal ID as a path parameter and the person ID as a body parameter. The response includes details of the added participant, such as their ID, name, email, and phone number, as well as information about the related deal and the user who added the participant. The response also contains related objects, including user and person details.
Input Fields: Input Fields
Output Fields: Output Fields

Add person picture

ID: post_add_person_picture
Operation: write
Entities: person, parameter, picture
Summary: This API endpoint allows you to add a picture to a person in the Pipedrive system. If a picture is already set for the person, the old picture will be replaced. The image or the cropping parameters supplied with the request should have an equal width and height and should be at least 128 pixels. Accepted image formats are GIF, JPG, and PNG. All added images will be resized to 128 and 512 pixel wide squares. The request requires the person's ID as a path parameter and the image file as a body parameter in multipart/form-data encoding. Optional cropping parameters include crop_x, crop_y, crop_width, and crop_height. The response includes the success status and details of the added picture, including URLs for the resized images.
Input Fields: Input Fields
Output Fields: Output Fields

Add a product to a deal

ID: post_add_product_to_deal
Operation: write
Entities: deal-product, deal, product
Summary: This API adds a product to a deal, creating a new item called a deal-product. It requires the deal ID as a path parameter and several body parameters including product_id, item_price, and quantity. Optional parameters include tax, comments, discount, and others related to billing frequency and start date. The response includes details of the newly created deal-product, such as its ID, sum, tax, and other attributes.
Input Fields: Input Fields
Output Fields: Output Fields

Add a product variation

ID: post_add_product_variation
Operation: write
Entities: variation, price, product
Summary: This API adds a new product variation to a specified product in the Pipedrive system. It requires the product ID as a path parameter and the product variation details in the request body. The body must include the name of the product variation and can include an array of price details. Each price detail includes currency, price, and optionally cost and notes. The response indicates success and provides the details of the newly created product variation, including its ID, name, associated product ID, and price details.
Input Fields: Input Fields
Output Fields: Output Fields

Add a recurring subscription

ID: post_add_recurring_subscription
Operation: write
Entities: payment, deal, subscription
Summary: This API adds a new recurring subscription to a specified deal. It requires the deal ID, currency, cadence type, cycle amount, and start date as mandatory fields. Optionally, you can provide a description, cycles count, infinite flag, additional payments, and update deal value flag. The response includes details about the subscription such as its ID, user ID, deal ID, status, cycle amount, cycles count, currency, start and end dates, description, and lifetime value.
Input Fields: Input Fields
Output Fields: Output Fields

Add role assignment

ID: post_add_role_assignment
Operation: write
Entities: user, role
Summary: The 'Add role assignment' API assigns a user to a specified role. It requires a POST request to the endpoint 'https://api.pipedrive.com/v1/roles/{id}/assignments'. The path parameter 'id' is required and represents the ID of the role. The request body must include the 'user_id', which is the ID of the user to be assigned. The response returns a success status and the IDs of the user and role involved in the assignment.
Input Fields: Input Fields
Output Fields: Output Fields

Add users to a team

ID: post_add_users_to_team
Operation: write
Entities: user, team
Summary: This API adds users to an existing team. It requires the team ID as a path parameter and a list of user IDs in the request body. The response indicates whether the operation was successful and returns the list of user IDs that were added.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a project

ID: post_archive_a_project
Operation: write
Entities: project
Summary: The 'Archive a project' API archives a project in the Pipedrive system. It requires the project ID as a path parameter. The response includes details about the project, such as its ID, title, description, status, and associated metadata like owner ID, labels, and archive time. The response indicates success with a boolean value and provides additional data if available.
Input Fields: Input Fields
Output Fields: Output Fields

Attach an audio file to the call log

ID: post_attach_audio_file_to_call_log
Operation: write
Entities: recording, call log
Summary: This API allows you to attach an audio recording to a call log in Pipedrive. The audio can be played by users who have access to the call log object. The request requires a path parameter 'id', which is the ID of the call log, and a body parameter 'file', which is the audio file in a format supported by HTML5. The response returns a success status indicating whether the audio file was successfully attached.
Input Fields: Input Fields
Output Fields: Output Fields

Create a new Webhook

ID: post_create_a_new_webhook
Operation: write
Entities: user, webhook, event
Summary: This API creates a new Webhook in Pipedrive and returns its details. The request requires a subscription_url, event_action, and event_object as mandatory fields. The subscription_url is the endpoint where notifications will be sent. The event_action specifies the type of action to receive notifications about, and the event_object specifies the type of object. Optional fields include user_id, http_auth_user, http_auth_password, and version. The response includes the status, success flag, and data about the created webhook, such as its ID, company ID, owner ID, user ID, event details, subscription URL, version, and other metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Create an organization relationship

ID: post_create_organization_relationship
Operation: write
Entities: relationship, organization relationship, organization
Summary: This API creates and returns an organization relationship in Pipedrive. It requires the type of relationship, the owner organization ID, and the linked organization ID as mandatory fields. The optional field is the base organization ID for calculated values. The response includes the success status, details of the created relationship, and related organization objects.
Input Fields: Input Fields
Output Fields: Output Fields

Create a remote file and link it to an item

ID: post_create_remote_file_and_link_to_item
Operation: write
Entities: file, remote location, item
Summary: This API creates a new empty file in a remote location (Google Drive) and links it to a specified item in Pipedrive. The request requires the file type, title, item type, item ID, and remote location as body parameters. The response includes details about the created file, such as its ID, type, size, and associated item details.
Input Fields: Input Fields
Output Fields: Output Fields

Duplicate Deal

ID: post_duplicate_deal
Operation: write
Entities: person, deal, organization
Summary: The Duplicate Deal API duplicates an existing deal in the Pipedrive system. It requires the ID of the deal to be duplicated as a path parameter. The API returns a success status and the details of the duplicated deal, including its ID, creator user ID, associated person and organization IDs, stage ID, title, value, currency, and various timestamps and counts related to activities, notes, and emails. The response also includes information about the deal's status, visibility, and other metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Link a remote file to an item

ID: post_link_remote_file_to_item
Operation: write
Entities: file, remote file, item
Summary: This API endpoint allows you to link an existing remote file from Google Drive to a specified item in Pipedrive. The request requires the item type (deal, organization, or person), the ID of the item, the remote file ID, and the remote location (currently only 'googledrive' is supported). Upon successful linking, the response returns details about the linked file, including its ID, associated user, deal, person, organization, product, activity, and lead information, as well as metadata such as file name, type, size, and download URL.
Input Fields: Input Fields
Output Fields: Output Fields

Link a user with the installed video call integration

ID: post_link_user_with_installed_video_call_integration
Operation: write
Entities: user, company, integration
Summary: This API endpoint is used by a video calling provider to link a user with the installed video call integration in Pipedrive. It requires the unique user provider ID, Pipedrive user ID, company ID, and the Pipedrive Marketplace client ID of the installed integration. Upon successful linking, it returns a success message indicating that the user was added successfully.
Input Fields: Input Fields
Output Fields: Output Fields

Receives an incoming message

ID: post_receives_an_incoming_message
Operation: write
Entities: message, attachment, conversation
Summary: The 'Receives an incoming message' API allows you to add a message to a conversation. To use this endpoint, you must have the Messengers integration OAuth scope enabled and the Messaging manifest ready for the Messaging app extension. The API requires several parameters in the request body, including 'id', 'channel_id', 'sender_id', 'conversation_id', 'message', 'status', and 'created_at'. Optional parameters include 'reply_by', 'conversation_link', and 'attachments'. The response includes a success flag and data about the message, such as its ID, channel ID, sender ID, conversation ID, message content, status, creation date, reply-by date, conversation link, and any attachments.
Input Fields: Input Fields
Output Fields: Output Fields

Cancel a recurring subscription

ID: put_cancel_a_recurring_subscription
Operation: write
Entities: subscription
Summary: This API cancels a recurring subscription. It requires the subscription ID as a path parameter. Optionally, an end_date can be provided in the body to specify the termination date of the subscription. The response includes a success flag and detailed information about the subscription, such as user ID, deal ID, cycle amount, currency, start and end dates, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Merge two deals

ID: put_merge_two_deals
Operation: write
Entities: deal, activity, pipeline
Summary: The 'Merge two deals' API allows users to merge one deal with another in the Pipedrive system. The API requires the ID of the deal to be merged (specified in the path parameter) and the ID of the deal to merge with (specified in the body parameter). Upon successful merging, the API returns a detailed response of the merged deal, including information such as the deal ID, creator user ID, associated person and organization IDs, deal title, value, currency, and various timestamps related to the deal's lifecycle. The response also includes counts of products, files, notes, followers, email messages, activities, and participants associated with the deal.
Input Fields: Input Fields
Output Fields: Output Fields

Merge two organizations

ID: put_merge_two_organizations
Operation: write
Entities: organization
Summary: This API merges an organization with another organization. It requires the ID of the organization to be merged (specified in the path parameter) and the ID of the organization to merge with (specified in the body parameter). The response indicates whether the merge was successful and provides the ID of the merged organization.
Input Fields: Input Fields
Output Fields: Output Fields

Merge two persons

ID: put_merge_two_persons
Operation: write
Entities: person, deal, organization
Summary: The 'Merge two persons' API allows you to merge one person with another in the Pipedrive system. The API requires the ID of the person to be merged (path parameter) and the ID of the person to merge with (body parameter). The person specified in the body parameter will have their data prioritized in case of conflicts. The response includes a success flag and detailed information about the merged person, including their ID, name, contact details, and activity counts.
Input Fields: Input Fields
Output Fields: Output Fields

Update a deal field

ID: put_update_a_deal_field
Operation: write
Entities: option, deal field
Summary: This API updates a deal field in Pipedrive. It requires the field ID as a path parameter. The request body can include the field name, options, and visibility flag. The response includes the updated field details, such as ID, key, name, type, and various flags indicating the field's properties and permissions.
Input Fields: Input Fields
Output Fields: Output Fields

Update a note

ID: put_update_a_note
Operation: write
Entities: deal, note, organization
Summary: This API updates a note in the Pipedrive system. It requires the note ID as a path parameter. The request body can include various optional parameters such as content, lead_id, deal_id, person_id, org_id, user_id, add_time, and pinning flags. The response includes a success flag and the updated note data, including details about the note's associations with deals, leads, organizations, and persons, as well as user information.
Input Fields: Input Fields
Output Fields: Output Fields

Update a person

ID: put_update_a_person
Operation: write
Entities: person, organization, user
Summary: The 'Update a person' API allows you to update the properties of a person in the Pipedrive system. The API endpoint is 'https://api.pipedrive.com/v1/persons/{id}' and it uses the PUT method. You must provide the 'id' of the person as a path parameter. The request body can include various optional fields such as 'name', 'owner_id', 'org_id', 'email', 'phone', 'label', 'label_ids', 'visible_to', 'marketing_status', and 'add_time'. The response will include a success flag and the updated person data, including details like 'id', 'company_id', 'owner_id', 'org_id', 'name', 'email', 'phone', and more. If the company uses the Campaigns product, the 'marketing_status' field will also be accepted and returned.
Input Fields: Input Fields
Output Fields: Output Fields

Update a person field

ID: put_update_a_person_field
Operation: write
Entities: option, person field
Summary: This API updates a person field in Pipedrive. It requires the field ID as a path parameter. The request body can include the name of the field, options for the field if it is of type 'set' or 'enum', and a flag indicating if the field should be visible in the 'add new' modal. The response includes a success flag and the updated details of the person field, such as its ID, key, name, type, and various flags indicating its properties and options.
Input Fields: Input Fields
Output Fields: Output Fields

Update a project

ID: put_update_a_project
Operation: write
Entities: project, deal, organization
Summary: The 'Update a project' API allows users to update the details of an existing project in Pipedrive. The API requires the project ID as a path parameter. The request body can include optional parameters such as title, board_id, phase_id, description, status, owner_id, start_date, end_date, deal_ids, org_id, person_id, and labels to update the respective fields of the project. The response returns a success status and the updated project details, including fields like id, title, description, status, status_change_time, start_date, end_date, owner_id, add_time, update_time, labels, archive_time, deal_ids, person_id, org_id, board_id, and phase_id.
Input Fields: Input Fields
Output Fields: Output Fields

Update a recurring subscription

ID: put_update_a_recurring_subscription
Operation: write
Entities: payment, deal, subscription
Summary: This API updates a recurring subscription. It requires the subscription ID as a path parameter. The request body can include optional parameters such as description, cycle_amount, payments, update_deal_value, and a required effective_date. The response includes a success flag and the updated subscription details, such as id, user_id, deal_id, is_active status, cycle_amount, cycles_count, currency, start_date, end_date, description, add_time, update_time, lifetime_value, cadence_type, and final_status.
Input Fields: Input Fields
Output Fields: Output Fields

Update a team

ID: put_update_a_team
Operation: write
Entities: user, team
Summary: This API updates an existing team in the Pipedrive system and returns the updated team object. The request requires the team ID as a path parameter. The request body can include optional parameters such as the team name, description, manager ID, list of user IDs, active flag, and deleted flag. The response includes a success flag and the updated team object with details such as the team ID, name, description, manager ID, user IDs, active and deleted flags, the time the team was added, and the ID of the user who created the team.
Input Fields: Input Fields
Output Fields: Output Fields

Update activity in project plan

ID: put_update_activity_in_project_plan
Operation: write
Entities: project, activity, phase
Summary: This API updates an activity phase or group in a project. It requires the project ID and activity ID as path parameters. Optionally, you can provide the phase ID and group ID in the request body to specify the new phase or group for the activity. The response includes a success flag and details of the updated activity, including its ID, type, phase ID, and group ID.
Input Fields: Input Fields
Output Fields: Output Fields

Update an activity type

ID: put_update_activity_type
Operation: write
Entities: activity type
Summary: This API updates an existing activity type in the Pipedrive system. It requires the ID of the activity type as a path parameter. The request body can include optional parameters such as 'name', 'icon_key', 'color', and 'order_nr' to update the respective fields of the activity type. The response returns a success flag and the updated details of the activity type, including its ID, name, icon key, color, and timestamps for when it was added and last updated.
Input Fields: Input Fields
Output Fields: Output Fields

Update an activity

ID: put_update_an_activity
Operation: write
Entities: deal, activity, person
Summary: The 'Update an activity' API allows users to update details of an existing activity in Pipedrive. The API requires the activity ID as a path parameter. The request body can include various optional parameters such as due_date, due_time, duration, deal_id, lead_id, person_id, project_id, org_id, location, public_description, note, subject, type, user_id, participants, busy_flag, attendees, and done status. The response includes the updated activity details and related objects information. Starting from 30.09.2024, activity attendees will receive updates only if the activity owner has an active calendar sync.
Input Fields: Input Fields
Output Fields: Output Fields

Update an installment subscription

ID: put_update_an_installment_subscription
Operation: write
Entities: payment, deal, subscription
Summary: This API updates an installment subscription. It requires the subscription ID as a path parameter. The request body must include an array of payments, each with an amount, description, and due date. Optionally, the request can include a boolean to update the deal value to the subscription's total value. The response includes the success status and details of the updated subscription, such as user ID, deal ID, active status, cycle amount, currency, start and end dates, description, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Update an organization

ID: put_update_an_organization
Operation: write
Entities: user, label, organization
Summary: This API updates the properties of an organization in Pipedrive. It requires the organization ID as a path parameter. The request body can include optional parameters such as the organization's name, owner ID, label, label IDs, and visibility settings. The response returns a success flag and the updated organization data, including details like the organization ID, name, owner information, deal counts, activity counts, and address details. Related objects such as organization, user, and picture details are also included in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Update a comment related to a note

ID: put_update_comment_related_to_note
Operation: write
Entities: user, comment, note
Summary: This API updates a comment related to a note. It requires the note ID and comment ID as path parameters. The request body must include the content of the comment in HTML format, which will be sanitized on the back-end. The response includes a success flag and data about the updated comment, such as its UUID, active status, timestamps, and user IDs.
Input Fields: Input Fields
Output Fields: Output Fields

Update existing goal

ID: put_update_existing_goal
Operation: write
Entities: type, goal, assignee
Summary: This API updates an existing goal in the Pipedrive system. It requires the goal ID as a path parameter. The request body can include the title, assignee, type, expected outcome, duration, and interval of the goal. The response includes the updated goal details, indicating success with a status code and text.
Input Fields: Input Fields
Output Fields: Output Fields

Update file details

ID: put_update_file_details
Operation: write
Entities: property, file, user
Summary: The 'Update file details' API allows you to update the properties of a file in the Pipedrive system. It requires the file ID as a path parameter and accepts optional body parameters 'name' and 'description' to update the file's visible name and description, respectively. The API returns a success status and detailed information about the updated file, including its ID, user ID, associated deal, person, organization, product, activity, and lead details, as well as file-specific information such as file name, type, size, and remote location.
Input Fields: Input Fields
Output Fields: Output Fields

Update filter

ID: put_update_filter
Operation: write
Entities: filter, condition, field
Summary: The 'Update filter' API allows you to update an existing filter in Pipedrive. You need to provide the filter ID as a path parameter. The request body can include the 'name' of the filter and the 'conditions' which is a required JSON object. The conditions can have a maximum of 16 conditions per filter and must follow a specific structure. The response includes the success status and the updated filter details such as ID, name, active status, type, user ID, and conditions.
Input Fields: Input Fields
Output Fields: Output Fields

Update mail thread details

ID: put_update_mail_thread_details
Operation: write
Entities: lead, deal, mail thread
Summary: The 'Update mail thread details' API allows users to update the properties of a mail thread in Pipedrive. The API endpoint is 'https://api.pipedrive.com/v1/mailbox/mailThreads/{id}', where 'id' is a required path parameter representing the ID of the mail thread to be updated. The request body can include optional parameters such as 'deal_id', 'lead_id', 'shared_flag', 'read_flag', and 'archived_flag' to specify the details to be updated. The response returns a success status and the updated mail thread details, including properties like 'id', 'folders', 'subject', 'message_count', 'read_flag', and timestamps for the first and last messages.
Input Fields: Input Fields
Output Fields: Output Fields

Update an organization field

ID: put_update_organization_field
Operation: write
Entities: organization field, option
Summary: This API updates an organization field in Pipedrive. The request requires the field ID as a path parameter. The body can include the field name, options, and visibility flag. The response returns the updated field details, including its ID, key, name, type, and various flags indicating its properties and permissions.
Input Fields: Input Fields
Output Fields: Output Fields

Update an organization relationship

ID: put_update_organization_relationship
Operation: write
Entities: relationship, organization
Summary: This API updates and returns an organization relationship in Pipedrive. It requires the ID of the organization relationship as a path parameter. The request body can include optional parameters such as 'org_id', 'type', 'rel_owner_org_id', and 'rel_linked_org_id' to specify the details of the relationship. The response includes the updated relationship details, including the owner and linked organization information, and related objects.
Input Fields: Input Fields
Output Fields: Output Fields

Update pipeline visibility for a role

ID: put_update_pipeline_visibility_for_a_role
Operation: write
Entities: role, pipeline
Summary: This API updates the visibility of specified pipelines for a given role. The role is identified by the 'id' path parameter, which is required. The request body must include 'visible_pipeline_ids', an object specifying pipeline IDs to add or remove from visibility. The response indicates success and provides the updated list of pipeline IDs and their visibility status.
Input Fields: Input Fields
Output Fields: Output Fields

Update a product field

ID: put_update_product_field
Operation: write
Entities: product field, option
Summary: This API updates a product field in Pipedrive. It requires the ID of the product field as a path parameter. The request body can include the name of the field and options if the field type is set or enum. The response includes details about the updated product field, such as its ID, key, name, order number, field type, and various flags indicating its properties and permissions.
Input Fields: Input Fields
Output Fields: Output Fields

Update role details

ID: put_update_role_details
Operation: write
Entities: parent role, role
Summary: This API updates the parent role and/or the name of a specific role in the Pipedrive system. It requires the role ID as a path parameter. Optionally, you can provide a new parent role ID and/or a new name for the role in the request body. The response indicates whether the update was successful and returns the ID of the updated role.
Input Fields: Input Fields
Output Fields: Output Fields

Update a task

ID: put_update_task
Operation: write
Entities: user, task, project
Summary: This API updates a task in the Pipedrive system. It requires the task ID as a path parameter. The request body can include optional parameters such as title, project_id, description, parent_task_id, assignee_id, done status, and due_date. The response includes the updated task details such as id, title, creator_id, description, done status, due_date, parent_task_id, assignee_id, add_time, update_time, marked_as_done_time, and project_id.
Input Fields: Input Fields
Output Fields: Output Fields

Update task in project plan

ID: put_update_task_in_project_plan
Operation: write
Entities: task, project, phase
Summary: This API updates a task phase or group in a project. It requires the project ID and task ID as path parameters. The request body can optionally include the phase_id and group_id to specify the new phase or group for the task. The response indicates whether the update was successful and provides details about the updated task, including its ID, type, phase ID, and group ID.
Input Fields: Input Fields
Output Fields: Output Fields

Update user details

ID: put_update_user_details
Operation: write
Entities: property, access, user
Summary: The 'Update user details' API allows you to update the properties of a user in the Pipedrive system. Currently, the only property that can be updated is the 'active_flag', which indicates whether the user is active or not. The API requires the user ID as a path parameter and the 'active_flag' as a body parameter. The response includes a success flag and detailed information about the user, such as their ID, name, email, phone number, activation status, and access permissions.
Input Fields: Input Fields
Output Fields: Output Fields