Pipedrive

1. Overview

Pipedrive is a cloud-based Customer Relationship Management (CRM) tool designed to help sales teams manage their sales pipeline, track leads, and close deals more effectively. It provides a visual interface for managing contacts, organizations, activities, and sales opportunities.

With the GoInsight Pipedrive node, you can seamlessly integrate your sales and customer management processes into your automated workflows. This allows you to perform a wide range of operations to manage your CRM data programmatically, including:

• Deal Management: Create, update, delete, search, and retrieve sales deals. You can also manage the products associated with each deal.
• Contact and Organization Management: Create, update, delete, and search for persons and organizations to keep your contact database current.
• Activity and Communication Tracking: Log new activities, create notes, and upload files, associating them with specific deals, persons, or organizations.
• Lead Management: Capture and manage new leads from various sources directly within your workflows.

2. Prerequisites

Before using this node, you need to have a valid Pipedrive account. Depending on your organization's security settings, you may need administrator privileges to generate an API token for authentication.

3. Credentials

For a detailed guide on how to obtain and configure credentials, please refer to our official documentation: Credentials Configuration Guide.

4. Supported Operations

Summary

This node provides comprehensive operations for managing core Pipedrive resources such as Activities, Deals, Files, Leads, Notes, Organizations, and Persons. The table below summarizes the available actions.

Operation Details

Add a Deal Product

Adds a product to a PipeDrive deal with specified pricing, quantity, and optional discount and tax parameters. Creates a product attachment to the deal and returns detailed product attachment information.

Input Parameters:

• DealId: The ID of the deal to add the product to (required)
• ProductId: The ID of the product to add (required)
• ItemPrice: The price per unit of the product (required)

Options:

• Quantity: Number of product units (default 1)
• Discount: Discount amount to apply (default 0)
• Tax: Tax amount to apply (default 0)
• Comments: Optional comments about the product attachment

Output:

• ProductAttachmentId (string): The ID of the created product attachment
• DealId (string): The ID of the deal the product was added to
• ProductId (string): The ID of the added product
• ProductName (string): The name of the added product
• ItemPrice (string): The price per unit of the product
• Quantity (string): The quantity of the product added
• Discount (string): The discount amount applied to the product
• Tax (string): The tax amount applied to the product
• Sum (string): The total amount for this product (price * quantity + tax - discount)
• Currency (string): The currency code for the product pricing
• Comments (string): Comments about the product attachment
• AddSuccess (bool): Whether the product was successfully added to the deal
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Create a Deal

Creates a new PipeDrive deal record with the specified title and optional parameters. The deal can be associated with contacts and organizations.

Input Parameters:

• Title: Deal title (required)

Options:

• PersonId: Associated person ID (optional)
• OrgId: Associated organization ID (optional)
• Value: Deal value (optional)
• Currency: Currency code (default USD)
• StageId: Deal stage ID (optional)
• PipelineId: Pipeline ID (optional)

Output:

• DealId (string): The ID of the created deal
• Title (string): The title of the created deal
• Value (string): The monetary value of the created deal
• Currency (string): The currency code of the deal
• Status (string): The status of the created deal
• PersonId (string): The ID of the associated person
• PersonName (string): The name of the associated person
• OrgId (string): The ID of the associated organization
• OrgName (string): The name of the associated organization
• StageId (string): The ID of the deal stage
• StageName (string): The name of the deal stage
• PipelineId (string): The ID of the sales pipeline
• PipelineName (string): The name of the sales pipeline
• CreatedTime (string): The timestamp when the deal was created
• UpdateTime (string): The timestamp when the deal was last updated
• CreateSuccess (bool): Whether the deal was successfully created
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Create a File

Creates a new PipeDrive file record by uploading Base64-encoded file content. The file must be associated with at least one entity: deals, contacts, organizations, products, activities, or leads.

Input Parameters:

• FileName: File name (required)
• FileContent: File content encoded in Base64 (required)

Options:

• DealId: Associated deal ID (optional)
• PersonId: Associated person ID (optional)
• OrgId: Associated organization ID (optional)
• ProductId: Associated product ID (optional)
• ActivityId: Associated activity ID (optional)
• LeadId: Associated lead ID (optional)

Output:

• FileId (string): The ID of the created file
• FileName (string): The name of the created file
• FileType (string): The type/extension of the created file
• FileSize (string): The size of the created file in bytes
• DealId (string): The ID of the associated deal
• DealTitle (string): The title of the associated deal
• PersonId (string): The ID of the associated person
• PersonName (string): The name of the associated person
• OrgId (string): The ID of the associated organization
• OrgName (string): The name of the associated organization
• ActivityId (string): The ID of the associated activity
• ProductId (string): The ID of the associated product
• ProductName (string): The name of the associated product
• ActivitySubject (string): The subject of the associated activity
• LeadId (string): The ID of the associated lead
• LeadTitle (string): The title of the associated lead
• CreatedTime (string): The timestamp when the file was created
• UpdateTime (string): The timestamp when the file was last updated
• CreateSuccess (bool): Whether the file was successfully created
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Create a Lead

Creates a new PipeDrive lead record with the specified title. Either PersonId or OrgId must be provided as the lead must be associated with a person or organization.

Input Parameters:

• Title: Lead title (required)

Options:

• PersonId: Associated person ID (either PersonId or OrgId required)
• OrgId: Associated organization ID (either PersonId or OrgId required)
• Value: Lead value (optional)
• Currency: Currency code (default USD)

Output:

• LeadId (string): The ID of the created lead
• Title (string): The title of the created lead
• Value (string): The value amount of the created lead
• Currency (string): The currency code of the lead value
• PersonId (string): The ID of the associated person
• PersonName (string): The name of the associated person
• OrgId (string): The ID of the associated organization
• OrgName (string): The name of the associated organization
• CreatedTime (string): The timestamp when the lead was created
• UpdateTime (string): The timestamp when the lead was last updated
• CreateSuccess (bool): Whether the lead was successfully created
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Create a Note

Creates a new PipeDrive note record with the specified content. The note can be associated with deals, contacts, organizations, leads, or projects.

Input Parameters:

• Content: Note content (required)

Options:

• DealId: Associated deal ID (optional)
• PersonId: Associated person ID (optional)
• OrgId: Associated organization ID (optional)
• LeadId: Associated lead ID (optional)
• ProjectId: Associated project ID (optional)

Output:

• NoteId (string): The ID of the created note
• Content (string): The content of the created note
• DealId (string): The ID of the associated deal
• DealTitle (string): The title of the associated deal
• PersonId (string): The ID of the associated person
• PersonName (string): The name of the associated person
• OrgId (string): The ID of the associated organization
• OrgName (string): The name of the associated organization
• LeadId (string): The ID of the associated lead
• LeadTitle (string): The title of the associated lead
• ProjectId (string): The ID of the associated project
• ProjectTitle (string): The title of the associated project
• CreatedTime (string): The timestamp when the note was created
• UpdateTime (string): The timestamp when the note was last updated
• CreateSuccess (bool): Whether the note was successfully created
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Create a Person

Creates a new PipeDrive person record with contact details and organization association.

Input Parameters:

• Name: Person full name (required)

Options:

• FirstName: Person first name (optional)
• LastName: Person last name (optional)
• Phone: Person phone number (optional)
• Email: Person email address (optional)
• OrganizationId: Associated organization ID (optional)

Output:

• PersonId (string): The ID of the created person
• Name (string): The full name of the created person
• FirstName (string): The first name of the created person
• LastName (string): The last name of the created person
• Phone (string): The phone number of the created person
• Email (string): The email address of the created person
• OrganizationId (string): The ID of the associated organization
• OrganizationName (string): The name of the associated organization
• OwnerId (string): The ID of the person owner
• OwnerName (string): The name of the person owner
• CreatedTime (string): The timestamp when the person was created
• UpdateTime (string): The timestamp when the person was last updated
• CreateSuccess (bool): Whether the person was successfully created
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Create an Activity

Creates a new PipeDrive activity record with the specified subject and optional parameters. The activity can be associated with deals, contacts, and organizations.

Input Parameters:

• Subject: Activity subject (required)

Options:

• Type: Activity type (optional)
• DueDate: Due date in YYYY-MM-DD format (optional)
• DueTime: Due time in HH:MM format (optional)
• Duration: Duration in minutes (optional)
• DealId: Associated deal ID (optional)
• PersonId: Associated person ID (optional)
• OrgId: Associated organization ID (optional)
• Note: Activity note (optional)

Output:

• ActivityId (string): The ID of the created activity
• Type (string): The type/category of the created activity
• Subject (string): The subject/title of the created activity
• DueDate (string): The due date of the activity
• DueTime (string): The due time of the activity
• Duration (string): The duration of the activity in minutes
• Done (string): Whether the activity is marked as done
• DealId (string): The ID of the associated deal
• PersonId (string): The ID of the associated person
• PersonName (string): The name of the associated person
• OrgId (string): The ID of the associated organization
• OrgName (string): The name of the associated organization
• CreatedTime (string): The timestamp when the activity was created
• UpdateTime (string): The timestamp when the activity was last updated
• Note (string): The note/comment attached to the activity
• CreateSuccess (bool): Whether the activity was successfully created
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Create an Organization

Creates a new PipeDrive organization record with the specified name and optional contact details. The organization can be associated with an owner.

Input Parameters:

• Name: Organization name (required)

Options:

• Address: Organization address (optional)
• Phone: Phone number (optional)
• Email: Email address (optional)
• Website: Website URL (optional)
• OwnerId: Owner ID (optional)

Output:

• OrganizationId (string): The ID of the created organization
• Name (string): The name of the created organization
• Address (string): The address of the created organization
• Phone (string): The phone number of the created organization
• Email (string): The email address of the created organization
• Website (string): The website URL of the created organization
• OwnerId (string): The ID of the organization owner
• OwnerName (string): The name of the organization owner
• PeopleCount (string): The number of people associated with the organization
• DealsCount (string): The number of deals associated with the organization
• ActivitiesCount (string): The number of activities associated with the organization
• CreatedTime (string): The timestamp when the organization was created
• UpdateTime (string): The timestamp when the organization was last updated
• CreateSuccess (bool): Whether the organization was successfully created
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Delete a Deal

Deletes a single PipeDrive deal record based on the specified deal ID. The deal will be permanently removed from the system.

Input Parameters:

• DealId: Deal ID to delete (required)

Output:

• DealId (string): The ID of the deleted deal
• DeleteSuccess (bool): Whether the deal was successfully deleted
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Delete a File

Deletes an existing PipeDrive file record by file ID. Returns the file information before deletion.

Input Parameters:

• FileId: File ID to delete (required)

Output:

• FileId (string): The ID of the deleted file
• FileName (string): The name of the deleted file
• FileType (string): The type/extension of the deleted file
• FileSize (string): The size of the deleted file in bytes
• DealId (string): The ID of the associated deal
• DealTitle (string): The title of the associated deal
• PersonId (string): The ID of the associated person
• PersonName (string): The name of the associated person
• OrgId (string): The ID of the associated organization
• OrgName (string): The name of the associated organization
• ActivityId (string): The ID of the associated activity
• ActivitySubject (string): The subject of the associated activity
• CreatedTime (string): The timestamp when the file was created
• UpdateTime (string): The timestamp when the file was last updated
• DeleteSuccess (bool): Whether the file was successfully deleted
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Delete a Lead

Deletes a single PipeDrive lead record based on the specified lead ID. The lead will be permanently removed from the system.

Input Parameters:

• LeadId: Lead ID to delete (required)

Output:

• LeadId (string): The ID of the deleted lead
• DeleteSuccess (bool): Whether the lead was successfully deleted
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Delete a Note

Deletes a single PipeDrive note record based on the specified note ID. The note will be permanently removed from the system.

Input Parameters:

• NoteId: Note ID to delete (required)

Output:

• NoteId (string): The ID of the deleted note
• DeleteSuccess (bool): Whether the note was successfully deleted
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Delete a Person

Deletes a PipeDrive person record by ID. Returns person details before deletion.

Input Parameters:

• PersonId: Person ID to delete (required)

Output:

• PersonId (string): The ID of the deleted person
• Name (string): The full name of the deleted person
• FirstName (string): The first name of the deleted person
• LastName (string): The last name of the deleted person
• Phone (string): The phone number of the deleted person
• Email (string): The email address of the deleted person
• OrganizationId (string): The ID of the associated organization
• OrganizationName (string): The name of the associated organization
• OwnerId (string): The ID of the person owner
• OwnerName (string): The name of the person owner
• CreatedTime (string): The timestamp when the person was created
• UpdateTime (string): The timestamp when the person was last updated
• DeleteSuccess (bool): Whether the person was successfully deleted
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Delete an Activity

Deletes a single PipeDrive activity record based on the specified activity ID. The activity will be permanently removed from the system.

Input Parameters:

• ActivityId: Activity ID to delete (required)

Output:

• ActivityId (string): The ID of the deleted activity
• DeleteSuccess (bool): Whether the activity was successfully deleted
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Delete an Organization

Deletes a PipeDrive organization record by ID. Returns organization details before deletion.

Input Parameters:

• OrganizationId: Organization ID to delete (required)

Output:

• OrganizationId (string): The ID of the deleted organization
• Name (string): The name of the deleted organization
• Address (string): The address of the deleted organization
• Phone (string): The phone number of the deleted organization
• Email (string): The email address of the deleted organization
• Website (string): The website URL of the deleted organization
• OwnerId (string): The ID of the organization owner
• OwnerName (string): The name of the organization owner
• PeopleCount (string): The number of people associated with the organization
• DealsCount (string): The number of deals associated with the organization
• ActivitiesCount (string): The number of activities associated with the organization
• CreatedTime (string): The timestamp when the organization was created
• UpdateTime (string): The timestamp when the organization was last updated
• DeleteSuccess (bool): Whether the organization was successfully deleted
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Get Activities

Retrieves multiple PipeDrive activity records by IDs. Supports batch operations with detailed success and failure reporting including 207 partial success status codes.

Input Parameters:

• ActivityIds: Comma-separated list of activity IDs to retrieve (required)

Output:

• Activities (string-array): Array of successfully retrieved activities as JSON string array
• SuccessCount (string): Number of activities successfully retrieved
• FailedItems (string-array): Array of failed activity IDs and errors as JSON string array
• TotalRequested (string): Total number of activities requested
• GetSuccess (bool): Whether all activities were successfully retrieved
• StatusCode (number): Operation result code (200 for all success, 207 for partial success, 500 for all failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Get Deal Products

Retrieves products associated with a PipeDrive deal. Returns detailed product information and total value.

Input Parameters:

• DealId: Deal ID to get products for (required)

Options:

• IncludeProductData: Include product detail data (optional, 1=include, 0=exclude, default 1)

Output:

• Products (string): Array of products associated with the deal as JSON string
• ProductCount (string): Total number of products in the deal
• TotalValue (string): Total value of all products in the deal
• DealId (string): The ID of the deal
• GetSuccess (bool): Whether the products were successfully retrieved
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Get Deals

Retrieves one or more PipeDrive deal records specified by their deal IDs. Supports batch retrieval with comma-separated IDs and returns data as JSON string arrays.

Input Parameters:

• DealId: Deal ID or comma-separated list of deal IDs to retrieve

Output:

• Deals (string-array): Array of retrieved deals as JSON strings, each containing complete deal information
• FailedItems (string-array): Array of failed deal retrieval attempts as JSON strings with error information
• StatusCode (number): Operation result code (200 for all success, 207 for partial success, 500 for all failed, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Get Leads

Retrieves one or more PipeDrive lead records. Supports batch operations by providing multiple lead IDs, or retrieves all leads if no specific IDs are provided.

Options:

• LeadIds: Comma-separated lead IDs to retrieve (e.g., '123,456,789'). If empty, retrieves all leads (optional)

Output:

• Leads (string-array): Array of retrieved leads as JSON strings, each containing complete lead information
• FailedItems (string-array): Array of failed lead retrieval attempts as JSON strings with error information
• StatusCode (number): Operation result code (200 for all success, 207 for partial success, 500 for all failed, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Get Notes

Retrieves one or more PipeDrive note records. Supports batch operations by providing multiple note IDs, or retrieves all notes if no specific IDs are provided.

Options:

• NoteIds: Comma-separated note IDs to retrieve (e.g., '123,456,789'). If empty, retrieves all notes (optional)

Output:

• Notes (string-array): Array of retrieved notes as JSON strings, each containing complete note information
• FailedItems (string-array): Array of failed note retrieval attempts as JSON strings with error information
• StatusCode (number): Operation result code (200 for all success, 207 for partial success, 500 for all failed, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Get Organizations

Retrieves multiple PipeDrive organization records by IDs. Supports batch operations with detailed success and failure reporting.

Input Parameters:

• OrganizationIds: Comma-separated list of organization IDs to retrieve (required)

Output:

• Organizations (string-array): Array of successfully retrieved organizations as JSON string array
• SuccessCount (string): Number of organizations successfully retrieved
• FailedItems (string-array): Array of failed organization IDs and errors as JSON string array
• TotalRequested (string): Total number of organizations requested
• GetSuccess (bool): Whether all organizations were successfully retrieved
• StatusCode (number): Operation result code (200 for all success, 207 for partial success, 500 for all failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Get Persons

Retrieves multiple PipeDrive person records by IDs. Supports batch operations with detailed success and failure reporting.

Input Parameters:

• PersonIds: Comma-separated list of person IDs to retrieve (required)

Output:

• Persons (string): Array of successfully retrieved persons as JSON string
• SuccessCount (string): Number of persons successfully retrieved
• FailedItems (string): Array of failed person IDs and errors as JSON string
• TotalRequested (string): Total number of persons requested
• GetSuccess (bool): Whether all persons were successfully retrieved
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Get Products

Retrieves PipeDrive products using API v2. Supports both batch retrieval by IDs and cursor-based paginated listing of all products. Returns arrays of JSON strings for Products and FailedItems.

Options:

• ProductIds: Comma-separated list of product IDs to retrieve (optional, for batch retrieval)
• Limit: Number of results to return (optional, default 100, for paginated listing)
• Cursor: Pagination cursor for next page (optional, empty for first page)

Output:

• Products (string-array): Array of product information as JSON strings
• SuccessCount (string): Number of products successfully retrieved
• FailedItems (string-array): Array of failed product IDs and error information as JSON strings (for batch retrieval)
• TotalRequested (string): Total number of products requested (for batch retrieval)
• TotalCount (string): Total count of all products (for paginated listing)
• NextCursor (string): Cursor value for the next page (empty if no next page)
• HasNextPage (bool): Whether there are more results available
• GetSuccess (bool): Whether products were successfully retrieved
• StatusCode (number): Operation result code (-1 for parameter validation error, 200 for success, 207 for partial failure, 500 for complete failure)
• ErrorMessage (string): Error message description, empty string if successful

Get a File

Retrieves detailed information about a PipeDrive file by file ID. Returns file metadata and associated entity information.

Input Parameters:

• FileId: File ID to retrieve details for (required)

Output:

• FileId (string): The ID of the file
• FileName (string): The name of the file
• FileType (string): The type/extension of the file
• FileSize (string): The size of the file in bytes
• DealId (string): The ID of the associated deal
• DealTitle (string): The title of the associated deal
• PersonId (string): The ID of the associated person
• PersonName (string): The name of the associated person
• OrgId (string): The ID of the associated organization
• OrgName (string): The name of the associated organization
• ActivityId (string): The ID of the associated activity
• ActivitySubject (string): The subject of the associated activity
• CreatedTime (string): The timestamp when the file was created
• UpdateTime (string): The timestamp when the file was last updated
• GetSuccess (bool): Whether the file details were successfully retrieved
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Remove a Deal Product

Removes a specific product attachment from a PipeDrive deal by product attachment ID. This operation permanently deletes the product-deal association and cannot be undone.

Input Parameters:

• DealId: The ID of the deal to remove the product from (required)
• ProductAttachmentId: The ID of the product attachment to remove (required)

Output:

• DealId (string): The ID of the deal the product was removed from
• ProductAttachmentId (string): The ID of the removed product attachment
• RemoveSuccess (bool): Whether the product was successfully removed from the deal
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Search Activities

Searches for PipeDrive activities using filter criteria like deal_id, person_id, org_id, or user_id with cursor-based pagination.

Options:

• DealId: Deal ID to filter activities associated with a specific deal
• PersonId: Person ID to filter activities associated with a specific person
• OrgId: Organization ID to filter activities associated with a specific organization
• UserId: User ID to filter activities owned by a specific user
• Done: Activity completion status filter: 0 for incomplete, 1 for completed, empty for all
• Limit: Maximum number of activities to return (default 10, max 500)
• Cursor: Cursor for pagination (empty for first page)

Output:

• Activities (string-array): Array of matching activities as JSON string array
• NextCursor (string): Cursor for next page (empty if no more results)
• CurrentCount (string): Number of results in current page
• TotalCount (string): Total number of activities found
• SearchSuccess (bool): Whether the search was successful
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Search Deal

Searches for PipeDrive deal records using a search term with optional parameters for pagination and exact matching. Returns multiple deal results as JSON string arrays with relevance scoring.

Input Parameters:

• SearchTerm: Search keyword or term (required, minimum 2 characters)

Options:

• Limit: Number of results to return (1-500, default 50)
• Cursor: Pagination cursor for next page (empty for first page)
• ExactMatch: Whether to use exact match (true/false, default false)

Output:

• SearchTerm (string): The search term used to find deals
• ReturnedCount (string): Number of deals returned in this search response
• NextCursor (string): Cursor value for the next page (empty if no next page)
• HasNextPage (bool): Whether there are more results available
• Deals (string-array): Array of found deals as JSON strings, each containing deal information and relevance score
• SearchSuccess (bool): Whether the search operation was successful
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Search Organizations

Searches for PipeDrive organization records using cursor-based pagination. Returns next_cursor from API response for seamless pagination navigation.

Input Parameters:

• Term: Search term (required)

Options:

• Limit: Maximum number of results to return (default 10, max 500)
• Cursor: Cursor for pagination (empty for first page)

Output:

• Organizations (string-array): Array of matching organizations as JSON string array
• CurrentCount (string): Number of results in current page
• NextCursor (string): Cursor for next page (empty if no more results)
• SearchTerm (string): The search term used
• SearchSuccess (bool): Whether the search was successful
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Search Persons

Searches for PipeDrive person records using cursor-based pagination. Returns next_cursor from API response for seamless pagination navigation.

Input Parameters:

• Term: Search keyword (required)

Options:

• Limit: Maximum number of results to return (default 10, max 500)
• Cursor: Cursor for pagination (empty for first page)

Output:

• Persons (string-array): Array of matching persons as JSON string array
• NextCursor (string): Cursor for next page (empty if no more results)
• CurrentCount (string): Number of results in current page
• SearchTerm (string): The search term used
• SearchSuccess (bool): Whether the search was successful
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Download a File

Downloads the content of a PipeDrive file by file ID. Returns the file content as Base64 encoded string.

Input Parameters:

• FileId: File ID to download (required)

Output:

• FileId (string): The ID of the downloaded file
• FileName (string): The name of the downloaded file
• FileType (string): The type/extension of the downloaded file
• FileSize (string): The size of the downloaded file in bytes
• FileContent (string): The file content encoded as Base64 string
• DealId (string): The ID of the associated deal
• DealTitle (string): The title of the associated deal
• PersonId (string): The ID of the associated person
• PersonName (string): The name of the associated person
• OrgId (string): The ID of the associated organization
• OrgName (string): The name of the associated organization
• ActivityId (string): The ID of the associated activity
• ActivitySubject (string): The subject of the associated activity
• CreatedTime (string): The timestamp when the file was created
• UpdateTime (string): The timestamp when the file was last updated
• DownloadSuccess (bool): Whether the file was successfully downloaded
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Duplicate a Deal

Duplicates a PipeDrive deal record by ID. Creates a copy with optional new title.

Input Parameters:

• DealId: Deal ID to duplicate (required)

Options:

• Title: New deal title (optional, defaults to original title + Copy)

Output:

• DealId (string): The ID of the duplicated deal
• Title (string): The title of the duplicated deal
• PersonId (string): The ID of the associated person
• PersonName (string): The name of the associated person
• OrganizationId (string): The ID of the associated organization
• OrganizationName (string): The name of the associated organization
• StageId (string): The ID of the deal stage
• StageName (string): The name of the deal stage
• PipelineId (string): The ID of the pipeline
• PipelineName (string): The name of the pipeline
• Value (string): The value of the deal
• Currency (string): The currency of the deal
• OwnerId (string): The ID of the deal owner
• OwnerName (string): The name of the deal owner
• Status (string): The status of the deal
• CreatedTime (string): The timestamp when the deal was created
• UpdateTime (string): The timestamp when the deal was last updated
• DuplicateSuccess (bool): Whether the deal was successfully duplicated
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Update Detail of a File

Updates the metadata and details of an existing PipeDrive file. Allows partial updates of file name, associations, and descriptions.

Input Parameters:

• FileId: File ID to update (required)

Options:

• FileName: New file name (optional)
• Description: File description (optional)

Output:

• FileId (string): The ID of the updated file
• FileName (string): The name of the updated file
• FileType (string): The type/extension of the updated file
• FileSize (string): The size of the updated file in bytes
• Description (string): The description of the updated file
• CreatedTime (string): The timestamp when the file was created
• UpdateTime (string): The timestamp when the file was last updated
• UpdateSuccess (bool): Whether the file was successfully updated
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Update a Deal

Updates a PipeDrive deal record with new details. Allows partial updates of deal fields.

Input Parameters:

• DealId: Deal ID to update (required)

Options:

• Title: Deal title (optional)
• Value: Deal value (optional)
• Currency: Deal currency (optional)
• StageId: Stage ID (optional)
• PersonId: Associated person ID (optional)
• OrganizationId: Associated organization ID (optional)
• OwnerId: Owner ID (optional)
• Status: Deal status (optional)

Output:

• DealId (string): The ID of the updated deal
• Title (string): The title of the updated deal
• PersonId (string): The ID of the associated person
• PersonName (string): The name of the associated person
• OrganizationId (string): The ID of the associated organization
• OrganizationName (string): The name of the associated organization
• StageId (string): The ID of the deal stage
• StageName (string): The name of the deal stage
• PipelineId (string): The ID of the pipeline
• PipelineName (string): The name of the pipeline
• Value (string): The value of the deal
• Currency (string): The currency of the deal
• OwnerId (string): The ID of the deal owner
• OwnerName (string): The name of the deal owner
• Status (string): The status of the deal
• CreatedTime (string): The timestamp when the deal was created
• UpdateTime (string): The timestamp when the deal was last updated
• UpdateSuccess (bool): Whether the deal was successfully updated
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Update a Deal Product

Updates an existing product attachment on a PipeDrive deal with new pricing, quantity, discount, tax, and comment information. Only the provided fields will be updated, allowing partial updates of product details.

Input Parameters:

• DealId: The ID of the deal containing the product (required)
• ProductAttachmentId: The ID of the product attachment to update (required)

Options:

• ItemPrice: The new price per unit of the product (optional)
• Quantity: New number of product units (optional)
• Discount: New discount amount to apply (optional)
• Tax: New tax amount to apply (optional)
• Comments: New comments about the product attachment (optional)

Output:

• ProductAttachmentId (string): The ID of the updated product attachment
• DealId (string): The ID of the deal containing the updated product
• ProductId (string): The ID of the updated product
• ProductName (string): The name of the updated product
• ItemPrice (string): The updated price per unit of the product
• Quantity (string): The updated quantity of the product
• Discount (string): The updated discount amount applied to the product
• Tax (string): The updated tax amount applied to the product
• Sum (string): The updated total amount for this product (price * quantity + tax - discount)
• Currency (string): The currency code for the product pricing
• Comments (string): The updated comments about the product attachment
• UpdateSuccess (bool): Whether the product was successfully updated
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Update a Lead

Updates an existing PipeDrive lead record with new information. Only the provided fields will be updated, allowing partial updates of lead details.

Input Parameters:

• LeadId: The ID of the lead to update (required)

Options:

• Title: Lead title (optional)
• PersonId: Associated person ID (optional)
• OrgId: Associated organization ID (optional)
• Value: Lead value (optional)
• Currency: Currency code (optional)

Output:

• LeadId (string): The ID of the updated lead
• Title (string): The title of the updated lead
• Value (string): The value amount of the updated lead
• Currency (string): The currency code of the lead value
• PersonId (string): The ID of the associated person
• PersonName (string): The name of the associated person
• OrgId (string): The ID of the associated organization
• OrgName (string): The name of the associated organization
• CreatedTime (string): The timestamp when the lead was created
• UpdateTime (string): The timestamp when the lead was last updated
• UpdateSuccess (bool): Whether the lead was successfully updated
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Update a Note

Updates an existing PipeDrive note record with new information. Only the provided fields will be updated, allowing partial updates of note details.

Input Parameters:

• NoteId: The ID of the note to update (required)

Options:

• Content: Note content (optional)
• DealId: Associated deal ID (optional)
• PersonId: Associated person ID (optional)
• OrgId: Associated organization ID (optional)
• LeadId: Associated lead ID (optional)

Output:

• NoteId (string): The ID of the updated note
• Content (string): The content of the updated note
• DealId (string): The ID of the associated deal
• DealTitle (string): The title of the associated deal
• PersonId (string): The ID of the associated person
• PersonName (string): The name of the associated person
• OrgId (string): The ID of the associated organization
• OrgName (string): The name of the associated organization
• LeadId (string): The ID of the associated lead
• LeadTitle (string): The title of the associated lead
• CreatedTime (string): The timestamp when the note was created
• UpdateTime (string): The timestamp when the note was last updated
• UpdateSuccess (bool): Whether the note was successfully updated
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Update a Person

Updates a PipeDrive person record with new details. Allows partial updates of person fields.

Input Parameters:

• PersonId: Person ID to update (required)

Options:

• Name: Person name (optional)
• FirstName: First name (optional)
• LastName: Last name (optional)
• Email: Email address (optional)
• Phone: Phone number (optional)
• OrganizationId: Organization ID (optional)
• OwnerId: Owner ID (optional)

Output:

• PersonId (string): The ID of the updated person
• Name (string): The name of the updated person
• FirstName (string): The first name of the updated person
• LastName (string): The last name of the updated person
• Email (string): The email address of the updated person
• Phone (string): The phone number of the updated person
• Organization (string): The organization name of the updated person
• OrganizationId (string): The organization ID of the updated person
• OwnerId (string): The ID of the person owner
• OwnerName (string): The name of the person owner
• DealsCount (string): The number of deals associated with the person
• ActivitiesCount (string): The number of activities associated with the person
• CreatedTime (string): The timestamp when the person was created
• UpdateTime (string): The timestamp when the person was last updated
• UpdateSuccess (bool): Whether the person was successfully updated
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Update an Activity

Updates a single PipeDrive activity record with the specified activity ID and optional field updates. At least one update field must be provided.

Input Parameters:

• ActivityId: Activity ID to update (required)

Options:

• Subject: Activity subject (optional)
• DueDate: Due date in YYYY-MM-DD format (optional)
• DueTime: Due time in HH:MM format (optional)
• Duration: Duration in minutes (optional)
• Done: Whether activity is done (true/false) (optional)
• Note: Activity note (optional)

Output:

• ActivityId (string): The ID of the updated activity
• Type (string): The type/category of the activity
• Subject (string): The subject/title of the activity
• DueDate (string): The due date of the activity
• DueTime (string): The due time of the activity
• Duration (string): The duration of the activity in minutes
• Done (string): Whether the activity is marked as done
• DealId (string): The ID of the associated deal
• PersonId (string): The ID of the associated person
• PersonName (string): The name of the associated person
• OrgId (string): The ID of the associated organization
• OrgName (string): The name of the associated organization
• CreatedTime (string): The timestamp when the activity was created
• UpdateTime (string): The timestamp when the activity was last updated
• Note (string): The note/comment attached to the activity
• UpdateSuccess (bool): Whether the activity was successfully updated
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

Update an Organization

Updates a PipeDrive organization record with new details. Allows partial updates of organization fields.

Input Parameters:

• OrganizationId: Organization ID to update (required)

Options:

• Name: Organization name (optional)
• Address: Organization address (optional)
• Phone: Phone number (optional)
• Email: Email address (optional)
• Website: Website URL (optional)
• OwnerId: Owner ID (optional)

Output:

• OrganizationId (string): The ID of the updated organization
• Name (string): The name of the updated organization
• Address (string): The address of the updated organization
• Phone (string): The phone number of the updated organization
• Email (string): The email address of the updated organization
• Website (string): The website URL of the updated organization
• OwnerId (string): The ID of the organization owner
• OwnerName (string): The name of the organization owner
• PeopleCount (string): The number of people associated with the organization
• DealsCount (string): The number of deals associated with the organization
• ActivitiesCount (string): The number of activities associated with the organization
• CreatedTime (string): The timestamp when the organization was created
• UpdateTime (string): The timestamp when the organization was last updated
• UpdateSuccess (bool): Whether the organization was successfully updated
• StatusCode (number): Operation result code (200 for success, 500 for failure, -1 for parameter validation error)
• ErrorMessage (string): Error message description, empty string if successful

5. Example Usage

This section demonstrates how to build a simple workflow to create a new deal in your Pipedrive account.

The workflow will consist of three nodes: Start -> Create a Deal -> Answer.

1. Add the Pipedrive Node

• In the workflow canvas, click the + button to add a new node.
• Select the Tools tab in the pop-up panel.
• Find and select Pipedrive from the list of tools.
• From the list of supported operations for Pipedrive, click on Create a Deal. This will add the node to your canvas.

2. Configure the Node

• Click on the newly added Create a Deal node to open its configuration panel on the right.
• Credentials: In the Credentials field at the top of the panel, click the dropdown menu and select your pre-configured Pipedrive credential.
• Parameters: Fill in the required input parameters for the action.
  • Title: Enter a descriptive title for the new deal, for example, New Q4 Project for Globex Corp.
  • Value: (Optional) Enter the monetary value of the deal, such as 25000.
  • Currency: (Optional) Specify the currency code, for example, USD.
  • PersonId: (Optional) If you want to link this deal to an existing contact, provide their Person ID here. You can get this ID from a previous Search Persons node.
  • OrgId: (Optional) Similarly, provide an Organization ID to link the deal to an existing organization.

3. Run and Validate

• Once all required parameters are correctly filled, any error indicators on the workflow canvas should disappear.
• Click the Run button in the top-right corner of the canvas to execute the workflow.
• After a successful execution, you can click the log icon in the top-right corner to view the detailed inputs and outputs of the node, confirming that the deal was created and retrieving its new DealId.

After completing these steps, your workflow is fully configured. When executed, it will create a new deal in your Pipedrive account with the details you provided.

6. FAQs

Q: Why am I getting a 401 Unauthorized or 403 Forbidden error?

A: This typically indicates an issue with your API credentials. Please check the following:

• Correct API Token: Ensure the API token you entered in the GoInsight credential configuration is correct and has not expired.
• Permissions: Verify that the user associated with the API token has the necessary permissions in Pipedrive to perform the requested action (e.g., create deals, read contacts).

Q: How do I find the PersonId or OrgId to associate with a new deal or activity?

A: You can build a multi-step workflow. In a step before creating the deal, use the Search Persons or Search Organizations operation with a known term (like an email address or company name). The output of that search node will provide the PersonId or OrgId, which you can then reference in the input fields of the Create a Deal node.

Q: My Create a File action is failing. What's a common issue?

A: The most common issues with file creation are:

• Invalid Base64: The content provided in the FileContent field must be a valid Base64 encoded string. Make sure your source data is correctly encoded before passing it to the node.
• Missing Association: Pipedrive requires a file to be associated with at least one other entity. You must provide a valid ID for at least one of the optional parameters like DealId, PersonId, or OrgId.

7. Official Documentation

For more detailed information about the Pipedrive API, including all available endpoints and parameters, please refer to the Pipedrive Official API Documentation.