# Pipedrive on boxd

> Pipedrive is a sales management tool built around pipeline visualization, lead tracking, activity reminders, and automation to keep deals progressing.

- Page: https://boxd.sh/integrations/pipedrive/
- CLI: `run pipedrive` (379 commands, 33 marked common)
- SDK: `import { pipedrive } from "@boxd/run"`; every parameter and response type is at `@boxd/run/pipedrive`
- Triggers: 3
- Connect: `run auth pipedrive` (API key), or https://app.boxd.sh/integrations/detail/pipedrive
- All integrations: https://boxd.sh/integrations/ (Markdown: https://boxd.sh/integrations/index.md)

## From the shell

```sh
run auth pipedrive      # once: prints a link to connect your account
run pipedrive           # list its commands
run pipedrive list-files
```

Parameters are flags (`--flag value`); object and array parameters take a JSON string. Output is YAML, or JSON with `--json`. Calls use your own connection; `--scope <name>` uses a connection shared with your team.

## From a script

```ts
import { pipedrive } from "@boxd/run";

const result = await pipedrive.listFiles({});
console.log(result);

pipedrive.on("new-deal", async (event) => {
  // New Deal Received Trigger: runs on this machine, once per event
  console.log(event);
});
```

Run it with `run pipedrive.run.ts`. A script that calls `.on()` keeps running as a job and handles each event.

## Commands

Required flags are listed; `run pipedrive <command> --help` lists the optional ones. "common" marks what `run pipedrive` shows without `--all`.

| Command | SDK method | Required flags | Optional | Description |
|---|---|---|---|---|
| `add-activity` ·common | `pipedrive.addActivity()` | `--subject` `--type` | 16 | New activity added |
| `add-activity-type` | `pipedrive.addActivityType()` | `--icon-key` `--name` | 1 | Adds a new activity type |
| `add-call-log` | `pipedrive.addCallLog()` | `--end-time` `--outcome` `--start-time` `--to-phone-number` | 10 | Adds a new call log |
| `add-call-log-audio-file` | `pipedrive.addCallLogAudioFile()` | `--file` `--id` | 0 | Attach an audio recording to an existing call log in Pipedrive |
| `add-channel` | `pipedrive.addChannel()` | `--name` `--provider-channel-id` | 3 | New messaging channel added; registration limited to admins |
| `add-deal` ·common | `pipedrive.addDeal()` | `--title` | 11 | Add a new deal to Pipedrive with any custom fields, which vary by account and are identified by long hash keys |
| `add-deal-discount` | `pipedrive.addDealDiscount()` | `--amount` `--description` `--id` `--type` | 0 | Add a discount to a deal in Pipedrive |
| `add-deal-field` | `pipedrive.addDealField()` | `--field-type` `--name` | 2 | Adds a new deal field |
| `add-deal-follower` | `pipedrive.addDealFollower()` | `--id` `--user-id` | 0 | Adds a follower to a deal |
| `add-deal-participant` | `pipedrive.addDealParticipant()` | `--id` `--person-id` | 0 | Adds a participant to a deal |
| `add-deal-product` | `pipedrive.addDealProduct()` | `--id` `--item-price` `--product-id` `--quantity` | 12 | Add a product to a deal in Pipedrive |
| `add-deal-products` ·common | `pipedrive.addDealProducts()` | `--data` `--id` | 0 | Bulk add products to a Pipedrive deal |
| `add-dealfields-options` | `pipedrive.addDealfieldsOptions()` | `--field-code` `--options` | 0 | Add new options to a deal custom field atomically |
| `add-file` | `pipedrive.addFile()` | — | 7 | Upload and link files to deals, people, organizations, activities, products, or leads in Pipedrive |
| `add-filter` | `pipedrive.addFilter()` | `--conditions` `--name` `--type` | 0 | New filter creation returns an ID |
| `add-goal` | `pipedrive.addGoal()` | `--assignee` `--duration` `--expected-outcome` `--interval` `--type` | 1 | Adds a new goal |
| `add-incoming-message` | `pipedrive.addIncomingMessage()` | `--channel-id` `--conversation-id` `--created-at` `--id` `--message` `--sender-id` `--status` | 3 | Adds a message to a conversation |
| `add-installment-subscription` | `pipedrive.addInstallmentSubscription()` | `--currency` `--deal-id` `--payments` | 1 | Adds a new installment subscription |
| `add-lead` ·common | `pipedrive.addLead()` | `--title` | 8 | Pipedrive API lets you add leads linked to people or organizations and tags them with 'API' source |
| `add-lead-label` | `pipedrive.addLeadLabel()` | `--color` `--name` | 0 | Creates a lead label |
| `add-note` | `pipedrive.addNote()` | `--content` | 12 | Add a note to a deal, person, organization, lead, or project in Pipedrive |
| `add-note-comment` | `pipedrive.addNoteComment()` | `--content` `--id` | 0 | Add a comment to an existing note in Pipedrive |
| `add-or-update-role-setting` | `pipedrive.addOrUpdateRoleSetting()` | `--id` `--setting-key` `--value` | 0 | Adds or updates the visibility setting for a role |
| `add-organization` | `pipedrive.addOrganization()` | `--name` | 2 | Creates a new organization in Pipedrive |
| `add-organization-field` | `pipedrive.addOrganizationField()` | `--field-type` `--name` | 2 | Adds a new organization field |
| `add-organization-field-options` | `pipedrive.addOrganizationFieldOptions()` | `--field-code` `--options` | 0 | Add new options to an organization field in Pipedrive |
| `add-organization-follower` | `pipedrive.addOrganizationFollower()` | `--id` `--user-id` | 0 | Add a follower to an organization in Pipedrive |
| `add-person` ·common | `pipedrive.addPerson()` | `--name` | 9 | Add a new contact in Pipedrive with optional custom fields unique to each account found using the `personFields` endpoint |
| `add-person-field` | `pipedrive.addPersonField()` | `--field-type` `--name` | 3 | Adds a new person field |
| `add-person-follower` | `pipedrive.addPersonFollower()` | `--id` `--user-id` | 0 | Add a follower to a person in Pipedrive |
| `add-person-picture` | `pipedrive.addPersonPicture()` | `--id` | 5 | This service allows adding a photo to a person's profile, replacing any existing one |
| `add-personfields-options` | `pipedrive.addPersonfieldsOptions()` | `--field-code` `--options` | 0 | Bulk add options to enum/set person fields atomically |
| `add-pipeline` | `pipedrive.addPipeline()` | `--name` | 1 | Adds a new pipeline (v2) |
| `add-product` ·common | `pipedrive.addProduct()` | `--name` | 11 | Adds a new product to the Products inventory |
| `add-product-field` | `pipedrive.addProductField()` | `--field-type` `--name` | 1 | Adds a new product field |
| `add-product-follower` | `pipedrive.addProductFollower()` | `--id` `--user-id` | 0 | Add a follower to a product in Pipedrive |
| `add-product-image` | `pipedrive.addProductImage()` | `--data` `--id` | 0 | Upload an image for a product in Pipedrive |
| `add-product-variation` | `pipedrive.addProductVariation()` | `--id` `--name` | 1 | Create a new product variation for an existing product |
| `add-productfields-options` | `pipedrive.addProductfieldsOptions()` | `--field-code` `--options` | 0 | Add new options to a product custom field that supports options (enum or set field types) |
| `add-project` | `pipedrive.addProject()` | `--board-id` `--phase-id` `--title` | 10 | Adds a new project |
| `add-recurring-subscription` | `pipedrive.addRecurringSubscription()` | `--cadence-type` `--currency` `--cycle-amount` `--deal-id` `--start-date` | 5 | Adds a new recurring subscription |
| `add-role` | `pipedrive.addRole()` | `--name` | 1 | Adds a new role |
| `add-role-assignment` | `pipedrive.addRoleAssignment()` | `--id` `--user-id` | 0 | Assigns a user to a role |
| `add-stage` | `pipedrive.addStage()` | `--name` `--pipeline-id` | 3 | Adds a new stage, returns the ID upon success |
| `add-task` | `pipedrive.addTask()` | `--project-id` `--title` | 5 | Adds a new task |
| `add-team` | `pipedrive.addTeam()` | `--manager-id` `--name` | 2 | Adds a new team to the company and returns the created object |
| `add-team-users` | `pipedrive.addTeamUsers()` | `--id` `--users` | 0 | Adds users to an existing team |
| `add-user` | `pipedrive.addUser()` | `--email` | 2 | Adds a new user to the company, returns the ID upon success |
| `archive-project` | `pipedrive.archiveProject()` | `--id` | 0 | Archives a project |
| `cancel-recurring-subscription` | `pipedrive.cancelRecurringSubscription()` | `--id` | 1 | Cancels a recurring subscription |
| `convert-deal-to-lead` | `pipedrive.convertDealToLead()` | `--id` | 0 | Convert a Pipedrive deal to a lead asynchronously |
| `convert-lead-to-deal` ·common | `pipedrive.convertLeadToDeal()` | `--id` | 2 | Convert a Pipedrive lead to a deal asynchronously |
| `create-organization-relationship` | `pipedrive.createOrganizationRelationship()` | `--rel-linked-org-id` `--rel-owner-org-id` `--type` | 1 | Creates and returns an organization relationship |
| `create-remote-file-link` | `pipedrive.createRemoteFileLink()` | `--file-type` `--item-id` `--item-type` `--remote-location` `--title` | 0 | Creates an empty file on Google Drive linked to an item |
| `create-webhook` | `pipedrive.createWebhook()` | `--event-action` `--event-object` `--name` `--subscription-url` | 4 | Creates and returns details of a new Webhook |
| `ctivityields-get-all-activityfields` | `pipedrive.ctivityieldsGetAllActivityfields()` | — | 3 | Retrieve metadata about all activity fields in the company |
| `deals-update-deal` ·common | `pipedrive.dealsUpdateDeal()` | `--id` `--product-attachment-id` | 13 | Update product details attached to a deal in Pipedrive using the v2 API |
| `delete-activities-bulk` | `pipedrive.deleteActivitiesBulk()` | `--ids` | 0 | Marks multiple activities as deleted |
| `delete-activity` | `pipedrive.deleteActivity()` | `--id` | 0 | Marks an activity as deleted |
| `delete-activity-type` | `pipedrive.deleteActivityType()` | `--id` | 0 | Delete an activity type in Pipedrive |
| `delete-activity-types-bulk` | `pipedrive.deleteActivityTypesBulk()` | `--ids` | 0 | Marks multiple activity types as deleted |
| `delete-call-log` | `pipedrive.deleteCallLog()` | `--id` | 0 | Deletes a call log |
| `delete-channel` | `pipedrive.deleteChannel()` | `--id` | 0 | The endpoint removes a messenger channel along with conversations and messages |
| `delete-comment` | `pipedrive.deleteComment()` | `--commentId` `--id` | 0 | Delete a comment from a note in Pipedrive |
| `delete-conversation` | `pipedrive.deleteConversation()` | `--channel--id` `--conversation--id` | 0 | Deletes an existing conversation |
| `delete-deal` ·common | `pipedrive.deleteDeal()` | `--id` | 0 | Delete a deal in Pipedrive |
| `delete-deal-discount` | `pipedrive.deleteDealDiscount()` | `--discount-id` `--id` | 0 | Delete a discount from a deal in Pipedrive |
| `delete-deal-field` | `pipedrive.deleteDealField()` | `--id` | 0 | Delete a deal field in Pipedrive by marking it as deleted |
| `delete-deal-field-options` | `pipedrive.deleteDealFieldOptions()` | `--field-code` `--options` | 0 | Remove existing options from a deal custom field atomically |
| `delete-deal-fields-bulk` | `pipedrive.deleteDealFieldsBulk()` | `--ids` | 0 | Marks multiple deal fields as deleted |
| `delete-deal-follower` | `pipedrive.deleteDealFollower()` | `--follower-id` `--id` | 0 | Delete a follower from a deal in Pipedrive |
| `delete-deal-participant` | `pipedrive.deleteDealParticipant()` | `--deal-participant-id` `--id` | 0 | Deletes a participant from a deal |
| `delete-deal-product` | `pipedrive.deleteDealProduct()` | `--id` `--product-attachment-id` | 0 | Delete an attached product from a deal in Pipedrive |
| `delete-deal-products` | `pipedrive.deleteDealProducts()` | `--id` | 1 | Delete multiple products from a deal in Pipedrive |
| `delete-deals-bulk` | `pipedrive.deleteDealsBulk()` | `--ids` | 0 | Marks multiple deals as deleted |
| `delete-file` | `pipedrive.deleteFile()` | `--id` | 0 | Delete a file in Pipedrive |
| `delete-filter` | `pipedrive.deleteFilter()` | `--id` | 0 | Delete a filter in Pipedrive |
| `delete-filters-bulk` | `pipedrive.deleteFiltersBulk()` | `--ids` | 0 | Marks multiple filters as deleted |
| `delete-goal` | `pipedrive.deleteGoal()` | `--id` | 0 | Marks a goal as deleted |
| `delete-lead` | `pipedrive.deleteLead()` | `--id` | 0 | Deletes a specific lead |
| `delete-lead-label` | `pipedrive.deleteLeadLabel()` | `--id` | 0 | Delete a specific lead label from Pipedrive |
| `delete-mail-thread` | `pipedrive.deleteMailThread()` | `--id` | 0 | Marks a mail thread as deleted |
| `delete-multiple-product-fields` | `pipedrive.deleteMultipleProductFields()` | `--ids` | 0 | Marks multiple fields as deleted |
| `delete-multiple-stages` | `pipedrive.deleteMultipleStages()` | `--ids` | 0 | Marks multiple stages as deleted (v1) |
| `delete-note` | `pipedrive.deleteNote()` | `--id` | 0 | Deletes a specific note |
| `delete-organization` ·common | `pipedrive.deleteOrganization()` | `--id` | 0 | Delete an organization in Pipedrive |
| `delete-organization-field` | `pipedrive.deleteOrganizationField()` | `--id` | 0 | Marks a field as deleted |
| `delete-organization-field-options` | `pipedrive.deleteOrganizationFieldOptions()` | `--field-code` `--options` | 0 | Delete specified options from an organization field in Pipedrive |
| `delete-organization-fields-bulk` | `pipedrive.deleteOrganizationFieldsBulk()` | `--ids` | 0 | Marks multiple fields as deleted |
| `delete-organization-follower` | `pipedrive.deleteOrganizationFollower()` | `--follower-id` `--id` | 0 | Delete a follower from an organization in Pipedrive |
| `delete-organization-relationship` | `pipedrive.deleteOrganizationRelationship()` | `--id` | 0 | Deletes an organization relationship and returns the deleted ID |
| `delete-organizations-bulk` | `pipedrive.deleteOrganizationsBulk()` | `--ids` | 0 | Marks multiple organizations as deleted |
| `delete-person` ·common | `pipedrive.deletePerson()` | `--id` | 0 | Delete a person in Pipedrive |
| `delete-person-field` | `pipedrive.deletePersonField()` | `--id` | 0 | Delete a person field from Pipedrive |
| `delete-person-field-options` | `pipedrive.deletePersonFieldOptions()` | `--field-code` `--options` | 0 | Remove existing options from a person custom field atomically |
| `delete-person-fields-bulk` | `pipedrive.deletePersonFieldsBulk()` | `--ids` | 1 | Marks multiple fields as deleted |
| `delete-person-follower` | `pipedrive.deletePersonFollower()` | `--follower-id` `--id` | 0 | Deletes a follower from a person |
| `delete-person-picture` | `pipedrive.deletePersonPicture()` | `--id` | 0 | Deletes a person’s picture |
| `delete-persons-bulk` | `pipedrive.deletePersonsBulk()` | `--ids` | 0 | Marks multiple persons as deleted |
| `delete-pipeline` | `pipedrive.deletePipeline()` | `--id` | 0 | Marks a pipeline as deleted |
| `delete-product` | `pipedrive.deleteProduct()` | `--id` | 0 | Marks a product as deleted |
| `delete-product-field` | `pipedrive.deleteProductField()` | `--id` | 0 | Marks a product field as deleted |
| `delete-product-field-options` | `pipedrive.deleteProductFieldOptions()` | `--field-code` `--options` | 0 | Remove existing options from a product custom field atomically |
| `delete-product-follower` | `pipedrive.deleteProductFollower()` | `--follower-id` `--id` | 0 | Deletes a follower from a product |
| `delete-product-image` | `pipedrive.deleteProductImage()` | `--id` `--image-id` | 0 | Delete an image from a product in Pipedrive |
| `delete-product-variation` | `pipedrive.deleteProductVariation()` | `--id` `--product-variation-id` | 0 | Delete a product variation from a product in Pipedrive |
| `delete-project` | `pipedrive.deleteProject()` | `--id` | 0 | Marks a project as deleted |
| `delete-role` | `pipedrive.deleteRole()` | `--id` | 0 | Marks a role as deleted |
| `delete-role-assignment` | `pipedrive.deleteRoleAssignment()` | `--id` `--user-id` | 0 | Removes the assigned user from a role and adds to the default role |
| `delete-stage` | `pipedrive.deleteStage()` | `--id` | 0 | Delete a stage in Pipedrive |
| `delete-subscription` | `pipedrive.deleteSubscription()` | `--id` | 0 | Marks an installment or a recurring subscription as deleted |
| `delete-task` | `pipedrive.deleteTask()` | `--id` | 0 | Marks a task as deleted |
| `delete-team-users` | `pipedrive.deleteTeamUsers()` | `--id` `--users` | 0 | Deletes users from an existing team |
| `delete-webhook` | `pipedrive.deleteWebhook()` | `--id` | 0 | Deletes the specified Webhook |
| `download-file` | `pipedrive.downloadFile()` | `--id` | 0 | Initializes a file download |
| `duplicate-deal` | `pipedrive.duplicateDeal()` | `--id` | 0 | Duplicates a deal |
| `duplicate-product` | `pipedrive.duplicateProduct()` | `--id` | 0 | Duplicate a specific product in Pipedrive |
| `enumerate-accessible-users-for-lead` | `pipedrive.enumerateAccessibleUsersForLead()` | `--id` | 0 | Lists the users permitted to access a lead |
| `find-goals` | `pipedrive.findGoals()` | — | 13 | Query goal data by appending `{searchField}={searchValue}` to the URL with dot-notation fields and values |
| `find-users-by-name` | `pipedrive.findUsersByName()` | `--term` | 1 | Finds users by their name |
| `get-activity` | `pipedrive.getActivity()` | `--id` | 0 | Returns the details of a specific activity |
| `get-activity-field` ·common | `pipedrive.getActivityField()` | `--field-code` | 1 | Retrieve detailed metadata for a specific activity field by its field code |
| `get-all-activities-assigned-to-particular-user` | `pipedrive.getAllActivitiesAssignedToParticularUser()` | — | 10 | Returns all activities assigned to a particular user |
| `get-all-activities-beta` | `pipedrive.getAllActivitiesBeta()` | — | 7 | This BETA cursor-paginated endpoint returns all activities, accessible only to global admins, not regular users who get a 403 error |
| `get-all-activity-fields` | `pipedrive.getAllActivityFields()` | — | 0 | Returns all activity fields |
| `get-all-activity-types` | `pipedrive.getAllActivityTypes()` | — | 0 | Returns all activity types |
| `get-all-deal-fields` | `pipedrive.getAllDealFields()` | — | 2 | Returns data about all deal fields |
| `get-all-deals` | `pipedrive.getAllDeals()` | — | 8 | Returns all deals |
| `get-all-deals-beta` | `pipedrive.getAllDealsBeta()` | — | 7 | This endpoint returns all deals with cursor pagination (in BETA) |
| `get-all-files` | `pipedrive.getAllFiles()` | — | 3 | Returns data about all files |
| `get-all-filter-helpers` | `pipedrive.getAllFilterHelpers()` | — | 0 | The text provides links to documentation for adding or updating filters, and information on all supported filter helpers in an API |
| `get-all-filters` | `pipedrive.getAllFilters()` | — | 1 | Returns data about all filters |
| `get-all-lead-labels` | `pipedrive.getAllLeadLabels()` | — | 0 | Returns details of all lead labels |
| `get-all-lead-sources` | `pipedrive.getAllLeadSources()` | — | 0 | Returns all lead sources |
| `get-all-leads` ·common | `pipedrive.getAllLeads()` | — | 8 | The API returns sorted leads by creation time, supporting pagination via `limit` and `start` |
| `get-all-note-fields` | `pipedrive.getAllNoteFields()` | — | 0 | Returns data about all note fields |
| `get-all-notes` | `pipedrive.getAllNotes()` | — | 14 | Returns all notes |
| `get-all-organization-fields` | `pipedrive.getAllOrganizationFields()` | — | 2 | Returns data about all organization fields |
| `get-all-organizations` | `pipedrive.getAllOrganizations()` | — | 6 | Returns all organizations |
| `get-all-organizations-beta` | `pipedrive.getAllOrganizationsBeta()` | — | 6 | This BETA API endpoint lists all organizations with cursor pagination |
| `get-all-permission-sets` | `pipedrive.getAllPermissionSets()` | — | 1 | Returns data about all permission sets |
| `get-all-person-fields` | `pipedrive.getAllPersonFields()` | — | 2 | Returns data about all person fields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the… |
| `get-all-persons` | `pipedrive.getAllPersons()` | — | 6 | Returns all persons |
| `get-all-persons-beta` | `pipedrive.getAllPersonsBeta()` | — | 6 | This BETA endpoint returns all persons, using cursor pagination |
| `get-all-pipelines` | `pipedrive.getAllPipelines()` | — | 0 | Returns data about all pipelines |
| `get-all-product-fields` | `pipedrive.getAllProductFields()` | — | 2 | Returns data about all product fields |
| `get-all-products` ·common | `pipedrive.getAllProducts()` | — | 7 | Returns data about all products |
| `get-all-project-boards` | `pipedrive.getAllProjectBoards()` | — | 0 | Returns all projects boards that are not deleted |
| `get-all-project-templates` | `pipedrive.getAllProjectTemplates()` | — | 2 | The endpoint retrieves all non-deleted project templates with cursor-based pagination |
| `get-all-projects` | `pipedrive.getAllProjects()` | — | 6 | Returns all projects |
| `get-all-relationships-for-organization` | `pipedrive.getAllRelationshipsForOrganization()` | `--org-id` | 0 | Gets all of the relationships for a supplied organization ID |
| `get-all-roles` | `pipedrive.getAllRoles()` | — | 2 | Returns all the roles within the company |
| `get-all-stages` | `pipedrive.getAllStages()` | — | 3 | Returns data about all stages |
| `get-all-supported-currencies` | `pipedrive.getAllSupportedCurrencies()` | — | 1 | Returns all supported currencies in given account which should be used when saving monetary values with other objects |
| `get-all-tasks` | `pipedrive.getAllTasks()` | — | 6 | Returns all tasks |
| `get-all-teams` | `pipedrive.getAllTeams()` | — | 2 | Returns data about teams within the company |
| `get-all-teams-of-user` | `pipedrive.getAllTeamsOfUser()` | `--id` | 2 | Returns data about all teams which have the specified user as a member |
| `get-all-user-connections` | `pipedrive.getAllUserConnections()` | — | 0 | Returns data about all connections for the authorized user |
| `get-all-users` | `pipedrive.getAllUsers()` | — | 0 | Returns data about all users within the company |
| `get-all-users-in-team` | `pipedrive.getAllUsersInTeam()` | `--id` | 0 | Returns a list of all user IDs within a team |
| `get-all-webhooks` | `pipedrive.getAllWebhooks()` | — | 0 | Returns data about all the Webhooks of a company |
| `get-archived-deals` | `pipedrive.getArchivedDeals()` | — | 16 | Get all archived deals from Pipedrive |
| `get-archived-leads` | `pipedrive.getArchivedLeads()` | — | 7 | Get all archived leads from Pipedrive |
| `get-call-log` | `pipedrive.getCallLog()` | `--id` | 0 | Retrieve details of a specific call log by ID |
| `get-comment` | `pipedrive.getComment()` | `--commentId` `--id` | 0 | Returns the details of a comment |
| `get-company-add-ons` | `pipedrive.getCompanyAddOns()` | — | 0 | Returns the add-ons for a single company |
| `get-conversations` | `pipedrive.getConversations()` | `--channel-id` | 3 | Retrieve messaging conversations |
| `get-current-user-data` | `pipedrive.getCurrentUserData()` | — | 0 | Returns data about an authorized user within the company with bound company data: company ID, company name, and domain |
| `get-deal` ·common | `pipedrive.getDeal()` | `--id` | 2 | Get details of a specific deal in Pipedrive |
| `get-deal-activities` ·deprecated | `pipedrive.getDealActivities()` | `--id` | 4 | Use PIPEDRIVE_PIPEDRIVE_ACTIVITIES_UPDATE_ACTIVITY or PIPEDRIVE_LIST_ACTIVITIES instead |
| `get-deal-changelog` | `pipedrive.getDealChangelog()` | `--id` | 2 | List updates about deal field values |
| `get-deal-field` ·common | `pipedrive.getDealField()` | `--id` | 0 | Retrieve a specific deal field by ID |
| `get-deal-files` | `pipedrive.getDealFiles()` | `--id` | 3 | List files attached to a deal |
| `get-deal-followers` | `pipedrive.getDealFollowers()` | `--id` | 2 | Lists users who are following the deal |
| `get-deal-followers-changelog` | `pipedrive.getDealFollowersChangelog()` | `--id` | 2 | Retrieve changelogs about users who have followed a deal |
| `get-deal-mail-messages` | `pipedrive.getDealMailMessages()` | `--id` | 2 | List mail messages associated with a deal in Pipedrive |
| `get-deal-participants` | `pipedrive.getDealParticipants()` | `--id` | 2 | List participants of a deal |
| `get-deal-participants-changelog` | `pipedrive.getDealParticipantsChangelog()` | `--id` | 2 | List updates about participants of a deal |
| `get-deal-products` | `pipedrive.getDealProducts()` | `--id` | 4 | List products attached to a deal |
| `get-deal-subscription` | `pipedrive.getDealSubscription()` | `--dealId` | 0 | Returns details of an installment or a recurring subscription by the deal ID |
| `get-deal-updates` | `pipedrive.getDealUpdates()` | `--id` | 4 | Lists updates about a deal in chronological order |
| `get-deal-users` | `pipedrive.getDealUsers()` | `--id` | 0 | List users permitted to access a deal |
| `get-deals-conversion-rates-in-pipeline` | `pipedrive.getDealsConversionRatesInPipeline()` | `--end-date` `--id` `--start-date` | 1 | Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period |
| `get-deals-convert-status` | `pipedrive.getDealsConvertStatus()` | `--conversion-id` `--id` | 0 | Retrieve the conversion status for a deal-to-lead conversion operation |
| `get-deals-discounts` | `pipedrive.getDealsDiscounts()` | `--id` | 0 | Retrieve discounts for a specific deal |
| `get-deals-in-pipeline` | `pipedrive.getDealsInPipeline()` | `--id` | 8 | Lists deals in a specific pipeline across all its stages |
| `get-deals-in-stage` | `pipedrive.getDealsInStage()` | `--id` | 5 | Lists deals in a specific stage |
| `get-deals-products` | `pipedrive.getDealsProducts()` | `--deal-ids` | 4 | Retrieve products attached to specified deals (max 100 deals per request) |
| `get-deals-summary` | `pipedrive.getDealsSummary()` | — | 4 | Returns a summary of all the deals |
| `get-deals-summary-archived` | `pipedrive.getDealsSummaryArchived()` | — | 5 | Retrieve summary statistics for archived deals |
| `get-deals-timeline` | `pipedrive.getDealsTimeline()` | `--amount` `--field-key` `--interval` `--start-date` | 5 | Returns opened and won deals in time-based groups according to a specified dealField, with examples of deals grouped by month over a 3-month period starting January 2012 |
| `get-deals-with-product` | `pipedrive.getDealsWithProduct()` | `--id` | 3 | Returns data about deals that have a product attached to it |
| `get-details-of-organization` | `pipedrive.getDetailsOfOrganization()` | `--id` | 0 | Provides detailed information about an organization, including additional fields not shown when listing all organizations, and maps custom fields as long hashes to the 'key' value in… |
| `get-details-of-person` ·deprecated | `pipedrive.getDetailsOfPerson()` | `--id` | 0 | Use PIPEDRIVE_PIPEDRIVE_GET_PERSON instead |
| `get-file` | `pipedrive.getFile()` | `--id` | 0 | Returns data about a specific file |
| `get-filter` | `pipedrive.getFilter()` | `--id` | 0 | Returns data about a specific filter |
| `get-goal-result` | `pipedrive.getGoalResult()` | `--id` `--period--end` `--period--start` | 0 | Gets the progress of a goal for the specified period |
| `get-lead-conversion-status` ·common | `pipedrive.getLeadConversionStatus()` | `--conversion-id` `--id` | 0 | Retrieve the conversion status for a specific lead conversion job |
| `get-lead-fields` | `pipedrive.getLeadFields()` | — | 2 | Retrieve all lead fields |
| `get-lead-users` | `pipedrive.getLeadUsers()` | `--id` | 0 | List users permitted to access a lead |
| `get-mail-message` | `pipedrive.getMailMessage()` | `--id` | 1 | Returns data about a specific mail message |
| `get-mail-thread` | `pipedrive.getMailThread()` | `--id` | 0 | Returns a specific mail thread |
| `get-mail-thread-messages` | `pipedrive.getMailThreadMessages()` | `--id` | 0 | Returns all the mail messages inside a specified mail thread |
| `get-mail-threads` | `pipedrive.getMailThreads()` | `--folder` | 2 | Returns mail threads in a specified folder ordered by the most recent message within |
| `get-marketplace-client-id` | `pipedrive.getMarketplaceClientId()` | — | 2 | Retrieve marketplace_client_id of an installed video integration |
| `get-note` | `pipedrive.getNote()` | `--id` | 0 | Returns details about a specific note |
| `get-note-comments` | `pipedrive.getNoteComments()` | `--id` | 2 | Returns all comments associated with a note |
| `get-one-lead` ·common | `pipedrive.getOneLead()` | `--id` | 0 | API returns specific lead details with custom field values in the Deals format |
| `get-organization` ·common | `pipedrive.getOrganization()` | `--id` | 2 | Get details of a specific organization in Pipedrive |
| `get-organization-changelog` | `pipedrive.getOrganizationChangelog()` | `--id` | 2 | List updates about organization field values |
| `get-organization-deals` | `pipedrive.getOrganizationDeals()` | `--id` | 5 | Lists deals associated with an organization |
| `get-organization-field` ·common | `pipedrive.getOrganizationField()` | `--id` | 0 | Retrieve a specific organization field by ID |
| `get-organization-files` | `pipedrive.getOrganizationFiles()` | `--id` | 3 | List files attached to an organization |
| `get-organization-followers` | `pipedrive.getOrganizationFollowers()` | `--id` | 2 | List followers of an organization |
| `get-organization-followers-changelog` | `pipedrive.getOrganizationFollowersChangelog()` | `--id` | 2 | List changelog about organization followers |
| `get-organization-mail-messages` | `pipedrive.getOrganizationMailMessages()` | `--id` | 2 | List mail messages associated with an organization |
| `get-organization-persons` | `pipedrive.getOrganizationPersons()` | `--id` | 2 | List persons associated with an organization |
| `get-organization-relationship` | `pipedrive.getOrganizationRelationship()` | `--id` | 1 | Finds and returns an organization relationship from its ID |
| `get-organization-updates` | `pipedrive.getOrganizationUpdates()` | `--id` | 4 | List updates about an organization including field value changes, activities, notes, files, and other related items |
| `get-organization-users` | `pipedrive.getOrganizationUsers()` | `--id` | 0 | List users permitted to access an organization |
| `get-permission-set` | `pipedrive.getPermissionSet()` | `--id` | 0 | Returns data about a specific permission set |
| `get-permission-set-assignments` | `pipedrive.getPermissionSetAssignments()` | `--id` | 2 | List permission set assignments for a given permission set |
| `get-person` ·common | `pipedrive.getPerson()` | `--id` | 2 | Get details of a specific person in Pipedrive |
| `get-person-changelog` | `pipedrive.getPersonChangelog()` | `--id` | 2 | List updates about person field values |
| `get-person-deals` | `pipedrive.getPersonDeals()` | `--id` | 4 | Lists deals associated with a person |
| `get-person-field` ·common | `pipedrive.getPersonField()` | `--id` | 0 | Retrieve metadata for a specific person field by its ID |
| `get-person-files` | `pipedrive.getPersonFiles()` | `--id` | 3 | List files attached to a person |
| `get-person-followers` | `pipedrive.getPersonFollowers()` | `--id` | 2 | List followers of a person in Pipedrive |
| `get-person-followers-changelog` | `pipedrive.getPersonFollowersChangelog()` | `--id` | 2 | Retrieve changelogs about users who have followed a person |
| `get-person-mail-messages` | `pipedrive.getPersonMailMessages()` | `--id` | 2 | List mail messages associated with a person in Pipedrive |
| `get-person-picture` ·common | `pipedrive.getPersonPicture()` | `--id` | 0 | Get picture details of a specific person in Pipedrive |
| `get-person-products` | `pipedrive.getPersonProducts()` | `--id` | 2 | List products associated with a person |
| `get-person-updates` | `pipedrive.getPersonUpdates()` | `--id` | 4 | Lists updates and activity history for a specific person in chronological order |
| `get-person-users` | `pipedrive.getPersonUsers()` | `--id` | 0 | List users permitted to access a person |
| `get-pipeline` | `pipedrive.getPipeline()` | `--id` | 1 | Returns data about a specific pipeline |
| `get-pipeline-conversion-statistics` | `pipedrive.getPipelineConversionStatistics()` | `--end-date` `--id` `--start-date` | 1 | Get deals conversion rates in a pipeline for a given time period |
| `get-pipeline-movement-statistics` | `pipedrive.getPipelineMovementStatistics()` | `--end-date` `--id` `--start-date` | 1 | Retrieve deal movement statistics within a pipeline for a specified time period |
| `get-product` | `pipedrive.getProduct()` | `--id` | 0 | Returns data about a specific product |
| `get-product-deals` | `pipedrive.getProductDeals()` | `--id` | 3 | List deals associated with a product |
| `get-product-field` | `pipedrive.getProductField()` | `--id` | 0 | Returns data about a specific product field |
| `get-product-files` | `pipedrive.getProductFiles()` | `--id` | 3 | List files attached to a product |
| `get-product-followers` | `pipedrive.getProductFollowers()` | `--id` | 2 | List all followers of a product in Pipedrive |
| `get-product-followers-changelog` | `pipedrive.getProductFollowersChangelog()` | `--id` | 2 | List changelog of followers for a product |
| `get-product-images` ·common | `pipedrive.getProductImages()` | `--id` | 0 | Retrieve image data for a specific product |
| `get-product-users` | `pipedrive.getProductUsers()` | `--id` | 0 | List users permitted to access a product in Pipedrive |
| `get-product-variations` | `pipedrive.getProductVariations()` | `--id` | 2 | Retrieve all product variations for a specific product with pagination support |
| `get-project` | `pipedrive.getProject()` | `--id` | 0 | Returns the details of a specific project |
| `get-project-activities` | `pipedrive.getProjectActivities()` | `--id` | 0 | Returns activities linked to a specific project |
| `get-project-board` | `pipedrive.getProjectBoard()` | `--id` | 0 | Returns the details of a specific project board |
| `get-project-groups` | `pipedrive.getProjectGroups()` | `--id` | 0 | Returns all active groups under a specific project |
| `get-project-phase` | `pipedrive.getProjectPhase()` | `--id` | 0 | Returns the details of a specific project phase |
| `get-project-phases` | `pipedrive.getProjectPhases()` | `--board-id` | 0 | Returns all active project phases under a specific board |
| `get-project-plan` | `pipedrive.getProjectPlan()` | `--id` | 0 | Returns information about items in a project plan |
| `get-project-tasks` | `pipedrive.getProjectTasks()` | `--id` | 0 | Returns tasks linked to a specific project |
| `get-recents` | `pipedrive.getRecents()` | `--since-timestamp` | 3 | Returns data about all recent changes occurred after the given timestamp |
| `get-role` | `pipedrive.getRole()` | `--id` | 0 | Retrieve details for a specific role by its ID |
| `get-role-assignments` | `pipedrive.getRoleAssignments()` | `--id` | 2 | Retrieve all users assigned to a specific role in Pipedrive |
| `get-role-pipelines` | `pipedrive.getRolePipelines()` | `--id` | 1 | Returns the visibility settings for pipelines associated with a specific role |
| `get-role-settings` | `pipedrive.getRoleSettings()` | `--id` | 0 | Retrieve visibility settings of a specific role |
| `get-stage` | `pipedrive.getStage()` | `--id` | 1 | Returns data about a specific stage |
| `get-subscription` | `pipedrive.getSubscription()` | `--id` | 0 | Returns details of an installment or a recurring subscription |
| `get-subscription-payments` | `pipedrive.getSubscriptionPayments()` | `--id` | 0 | Returns all payments of an installment or recurring subscription |
| `get-task` | `pipedrive.getTask()` | `--id` | 0 | Returns the details of a specific task |
| `get-team` | `pipedrive.getTeam()` | `--id` | 1 | Returns data about a specific team |
| `get-template` | `pipedrive.getTemplate()` | `--id` | 0 | Returns the details of a specific project template |
| `get-templates` | `pipedrive.getTemplates()` | `--channel-id` | 0 | Retrieve message templates for a channel |
| `get-user` | `pipedrive.getUser()` | `--id` | 0 | Returns data about a specific user within the company |
| `get-user-call-logs` | `pipedrive.getUserCallLogs()` | — | 2 | Returns all call logs assigned to a particular user |
| `get-user-followers` | `pipedrive.getUserFollowers()` | `--id` | 2 | List users who are following a specific user |
| `get-user-permissions` | `pipedrive.getUserPermissions()` | `--id` | 0 | List aggregated permissions over all assigned permission sets for a user |
| `get-user-role-assignments` | `pipedrive.getUserRoleAssignments()` | `--id` | 2 | List role assignments for a user |
| `get-user-role-settings` | `pipedrive.getUserRoleSettings()` | `--id` | 0 | List user role settings |
| `link-remote-file` | `pipedrive.linkRemoteFile()` | `--item-id` `--item-type` `--remote-id` `--remote-location` | 0 | Links an existing remote file (`googledrive`) to the item you supply |
| `link-user-video-integration` | `pipedrive.linkUserVideoIntegration()` | `--company-id` `--marketplace-client-id` `--user-id` `--user-provider-id` | 0 | A video calling provider must call this endpoint after a user has installed the video calling app so that the new user's information is sent |
| `list-deal-activities` | `pipedrive.listDealActivities()` | `--id` | 4 | Lists activities associated with a deal |
| `list-deal-files` | `pipedrive.listDealFiles()` | `--id` | 3 | Lists files associated with a deal |
| `list-deal-followers` | `pipedrive.listDealFollowers()` | `--id` | 0 | Lists the followers of a deal |
| `list-deal-mail-messages` | `pipedrive.listDealMailMessages()` | `--id` | 2 | Lists mail messages associated with a deal |
| `list-deal-persons` | `pipedrive.listDealPersons()` | `--id` | 2 | The endpoint lists every person linked to a deal, including primary contacts and participants, and provides a `data.marketing_status` field for users of the Campaigns product |
| `list-deal-products` | `pipedrive.listDealProducts()` | `--id` | 3 | Lists products attached to a deal |
| `list-deal-updates` | `pipedrive.listDealUpdates()` | `--id` | 4 | Lists updates about a deal |
| `list-deal-users` | `pipedrive.listDealUsers()` | `--id` | 0 | Lists the users permitted to access a deal |
| `list-files` ·common | `pipedrive.listFiles()` | — | 3 | Lists all files uploaded to Pipedrive with optional filtering via pagination and sorting |
| `list-organization-activities` | `pipedrive.listOrganizationActivities()` | `--id` | 4 | Lists activities associated with an organization |
| `list-organization-deals` | `pipedrive.listOrganizationDeals()` | `--id` | 5 | Lists deals associated with an organization |
| `list-organization-files` | `pipedrive.listOrganizationFiles()` | `--id` | 3 | Lists files associated with an organization |
| `list-organization-followers` | `pipedrive.listOrganizationFollowers()` | `--id` | 0 | Lists the followers of an organization |
| `list-organization-mail-messages` | `pipedrive.listOrganizationMailMessages()` | `--id` | 2 | Lists mail messages associated with an organization |
| `list-organization-persons` | `pipedrive.listOrganizationPersons()` | `--id` | 2 | Lists persons associated with an organization.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the… |
| `list-participants-of-deal` | `pipedrive.listParticipantsOfDeal()` | `--id` | 2 | Lists the participants associated with a deal.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the… |
| `list-permission-set-assignments` | `pipedrive.listPermissionSetAssignments()` | `--id` | 2 | Returns the list of assignments for a permission set |
| `list-person-activities` | `pipedrive.listPersonActivities()` | `--id` | 4 | Lists activities associated with a person |
| `list-person-deals` | `pipedrive.listPersonDeals()` | `--id` | 4 | Lists deals associated with a person |
| `list-person-files` | `pipedrive.listPersonFiles()` | `--id` | 3 | Lists files associated with a person |
| `list-person-followers` | `pipedrive.listPersonFollowers()` | `--id` | 0 | Lists the followers of a person |
| `list-person-mail-messages` | `pipedrive.listPersonMailMessages()` | `--id` | 2 | Lists mail messages associated with a person |
| `list-person-products` | `pipedrive.listPersonProducts()` | `--id` | 2 | Lists products associated with a person |
| `list-person-users` | `pipedrive.listPersonUsers()` | `--id` | 0 | List users permitted to access a person |
| `list-product-files` | `pipedrive.listProductFiles()` | `--id` | 3 | Lists files associated with a product |
| `list-product-followers` | `pipedrive.listProductFollowers()` | `--id` | 2 | Lists the followers of a product |
| `list-product-users` | `pipedrive.listProductUsers()` | `--id` | 0 | Lists users permitted to access a product |
| `list-role-assignments` | `pipedrive.listRoleAssignments()` | `--id` | 2 | Returns all users assigned to a role |
| `list-role-pipeline-visibility` | `pipedrive.listRolePipelineVisibility()` | `--id` | 1 | Returns a list of visible or hidden pipeline IDs by role |
| `list-role-settings` | `pipedrive.listRoleSettings()` | `--id` | 0 | Returns the visibility settings of a specific role |
| `list-updates-about-organization` | `pipedrive.listUpdatesAboutOrganization()` | `--id` | 4 | Lists updates about an organization |
| `list-updates-about-participants-of-deal` | `pipedrive.listUpdatesAboutParticipantsOfDeal()` | `--id` | 2 | This endpoint provides cursor-paginated updates on deal participants |
| `list-updates-about-person` | `pipedrive.listUpdatesAboutPerson()` | `--id` | 4 | Lists updates about a person.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint's response will also include updates for… |
| `list-user-followers` | `pipedrive.listUserFollowers()` | `--id` | 0 | Lists the followers of a specific user |
| `list-user-permissions` | `pipedrive.listUserPermissions()` | `--id` | 0 | Lists aggregated permissions over all assigned permission sets for a user |
| `list-user-role-assignments` | `pipedrive.listUserRoleAssignments()` | `--id` | 2 | Lists role assignments for a user |
| `list-user-role-settings` | `pipedrive.listUserRoleSettings()` | `--id` | 0 | Lists the settings of user's assigned role |
| `list-user-settings` | `pipedrive.listUserSettings()` | — | 0 | Lists the settings of an authorized user |
| `merge-deals` ·common | `pipedrive.mergeDeals()` | `--id` `--merge-with-id` | 0 | Merge two deals in Pipedrive |
| `merge-organizations` ·common | `pipedrive.mergeOrganizations()` | `--id` `--merge-with-id` | 0 | Merge two organizations in Pipedrive |
| `merge-persons` ·common | `pipedrive.mergePersons()` | `--id` `--merge-with-id` | 0 | Merge two persons in Pipedrive |
| `merge-two-deals` | `pipedrive.mergeTwoDeals()` | `--id` `--merge-with-id` | 0 | Merges a deal with another deal |
| `merge-two-organizations` | `pipedrive.mergeTwoOrganizations()` | `--id` `--merge-with-id` | 0 | Merges an organization with another organization |
| `merge-two-persons` | `pipedrive.mergeTwoPersons()` | `--id` `--merge-with-id` | 0 | Merges a person with another person |
| `organization-accessible-user-list` | `pipedrive.organizationAccessibleUserList()` | `--id` | 0 | List users permitted to access an organization |
| `patch-deal-fields` | `pipedrive.patchDealFields()` | `--field-code` | 5 | Updates an existing deal custom field using PATCH method |
| `patch-organization-fields` | `pipedrive.patchOrganizationFields()` | `--field-code` | 5 | Update an existing organization field in Pipedrive using the v2 API |
| `patch-person-fields` | `pipedrive.patchPersonFields()` | `--field-code` | 5 | Update person field configuration in Pipedrive |
| `productfields-patch-productfields` | `pipedrive.productfieldsPatchProductfields()` | `--field-code` | 3 | Update a product custom field |
| `refresh-tokens` | `pipedrive.refreshTokens()` | — | 4 | Access tokens expire after the time specified in `expires_in` |
| `request-authorization` | `pipedrive.requestAuthorization()` | `--client-id` `--redirect-uri` | 1 | Authorize a user by redirecting them to the Pipedrive OAuth authorization page and request their permissions to act on their behalf |
| `search-deals` | `pipedrive.searchDeals()` | `--term` | 8 | This API endpoint searches deals by title, notes, and custom fields, filters results by person or organization ID, and is a specific use case of /v1/itemSearch with limited OAuth scope |
| `search-item-by-field` | `pipedrive.searchItemByField()` | `--field-key` `--field-type` `--term` | 4 | Performs a search from the values of a specific field |
| `search-leads` | `pipedrive.searchLeads()` | `--term` | 7 | Endpoint searches leads by title, notes, custom fields, with options to filter by person and organization IDs, and is a more specific use of the /v1/itemSearch with limited OAuth scope |
| `search-multiple-item-types` | `pipedrive.searchMultipleItemTypes()` | `--term` | 7 | Performs a search from your choice of item types and fields |
| `search-organizations` | `pipedrive.searchOrganizations()` | `--term` | 4 | Searches all organizations by name, address, notes and/or custom fields |
| `search-persons` | `pipedrive.searchPersons()` | `--term` | 6 | This endpoint searches for individuals by various identifiers and is a specific use case of /v1/itemSearch with limited OAuth scope, allowing results filtering by organization ID |
| `search-products` | `pipedrive.searchProducts()` | `--term` | 5 | Searches all products by name, code and/or custom fields |
| `tages-update-stage` | `pipedrive.tagesUpdateStage()` | `--id` | 5 | Update an existing stage in Pipedrive |
| `unlink-user-from-video-call-integration` | `pipedrive.unlinkUserFromVideoCallIntegration()` | `--id` | 0 | A video calling provider must call this endpoint to remove the link between a user and the installed video calling app |
| `update-activity` | `pipedrive.updateActivity()` | `--id` | 12 | Updates an activity |
| `update-activity-in-project-plan` | `pipedrive.updateActivityInProjectPlan()` | `--activityId` `--id` | 2 | Updates an activity phase or group in a project |
| `update-activity-type` | `pipedrive.updateActivityType()` | `--id` | 4 | Updates an activity type |
| `update-comment-for-note` | `pipedrive.updateCommentForNote()` | `--commentId` `--content` `--id` | 0 | Update a comment on a note in Pipedrive |
| `update-comment-related-to-note` | `pipedrive.updateCommentRelatedToNote()` | `--commentId` `--content` `--id` | 0 | Updates a comment related to a note |
| `update-deal` ·common | `pipedrive.updateDeal()` | `--id` | 19 | Update an existing deal in Pipedrive |
| `update-deal-discount` | `pipedrive.updateDealDiscount()` | `--discount-id` `--id` | 3 | Update a discount for a specific deal |
| `update-deal-field` | `pipedrive.updateDealField()` | `--id` | 3 | Update a deal field in Pipedrive |
| `update-deal-product` | `pipedrive.updateDealProduct()` | `--id` `--product-attachment-id` | 11 | Updates a product attached to a deal with new values |
| `update-deal-product-attachment` | `pipedrive.updateDealProductAttachment()` | `--id` `--product-attachment-id` | 11 | Updates the details of the product that has been attached to a deal |
| `update-deal-v2` ·common | `pipedrive.updateDealV2()` | `--id` | 21 | Update an existing deal using Pipedrive v2 API |
| `update-dealfields-options` | `pipedrive.updateDealfieldsOptions()` | `--field-code` `--options` | 0 | Update existing options for a deal custom field atomically |
| `update-file` | `pipedrive.updateFile()` | `--id` | 2 | Updates the properties of a file including its visible name and description |
| `update-file-details` | `pipedrive.updateFileDetails()` | `--id` | 2 | Updates the properties of a file |
| `update-filter` | `pipedrive.updateFilter()` | `--id` | 1 | Updates an existing filter |
| `update-goal` | `pipedrive.updateGoal()` | `--id` | 6 | Updates an existing goal |
| `update-installment-subscription` | `pipedrive.updateInstallmentSubscription()` | `--id` `--payments` | 1 | Updates an installment subscription |
| `update-lead` ·common | `pipedrive.updateLead()` | `--id` | 12 | Update a lead in Pipedrive |
| `update-lead-label` | `pipedrive.updateLeadLabel()` | `--id` | 2 | Update a lead label in Pipedrive |
| `update-mail-thread` | `pipedrive.updateMailThread()` | `--id` | 5 | Updates the properties of a mail thread |
| `update-note` | `pipedrive.updateNote()` | `--id` | 13 | Update an existing note in Pipedrive |
| `update-organization` | `pipedrive.updateOrganization()` | `--id` | 5 | Update an existing organization in Pipedrive |
| `update-organization-field` | `pipedrive.updateOrganizationField()` | `--id` | 3 | Update an organization field in Pipedrive |
| `update-organization-field-options` | `pipedrive.updateOrganizationFieldOptions()` | `--field-code` `--options` | 0 | Update existing options for an organization custom field atomically |
| `update-organization-relationship` | `pipedrive.updateOrganizationRelationship()` | `--id` | 4 | Update an organization relationship in Pipedrive |
| `update-person` ·common | `pipedrive.updatePerson()` | `--id` | 11 | Update a person's properties in Pipedrive |
| `update-person-field` | `pipedrive.updatePersonField()` | `--id` | 3 | Update a person field in Pipedrive |
| `update-person-v2` ·common | `pipedrive.updatePersonV2()` | `--id` | 12 | Update a person's properties in Pipedrive using the v2 API |
| `update-personfields-options` | `pipedrive.updatePersonfieldsOptions()` | `--field-code` `--options` | 0 | Update existing options for a person custom field atomically |
| `update-pipeline` | `pipedrive.updatePipeline()` | `--id` | 4 | Update a pipeline in Pipedrive |
| `update-pipeline-visibility-for-role` | `pipedrive.updatePipelineVisibilityForRole()` | `--id` `--visible-pipeline-ids` | 0 | Updates pipeline visibility settings for different roles |
| `update-product` | `pipedrive.updateProduct()` | `--id` | 11 | Update a product in Pipedrive |
| `update-product-field` | `pipedrive.updateProductField()` | `--id` | 2 | Update a product field definition in Pipedrive |
| `update-product-image` | `pipedrive.updateProductImage()` | `--data` `--id` | 0 | Update an image for a product in Pipedrive |
| `update-product-variation` | `pipedrive.updateProductVariation()` | `--id` `--product-variation-id` | 2 | Update a product variation in Pipedrive |
| `update-productfields-options` | `pipedrive.updateProductfieldsOptions()` | `--field-code` `--options` | 0 | Update existing options for a product custom field atomically |
| `update-project` | `pipedrive.updateProject()` | `--id` | 12 | Updates a project |
| `update-recurring-subscription` | `pipedrive.updateRecurringSubscription()` | `--effective-date` `--id` | 4 | Updates a recurring subscription |
| `update-role` | `pipedrive.updateRole()` | `--id` | 2 | Updates the parent role and/or the name of a specific role |
| `update-role-pipelines` | `pipedrive.updateRolePipelines()` | `--id` `--visible-pipeline-ids` | 0 | Updates pipeline visibility for a role |
| `update-stage` | `pipedrive.updateStage()` | `--id` | 6 | Update stage details in Pipedrive |
| `update-stage-details` | `pipedrive.updateStageDetails()` | `--id` | 6 | Updates the properties of a stage |
| `update-task` | `pipedrive.updateTask()` | `--id` | 7 | Updates a task |
| `update-task-in-project-plan` | `pipedrive.updateTaskInProjectPlan()` | `--id` `--taskId` | 2 | Updates a task phase or group in a project |
| `update-team` | `pipedrive.updateTeam()` | `--id` | 6 | Updates an existing team and returns the updated object |

## Triggers

`pipedrive.on("<event>", handler)` in a script; required config goes before the handler as an object.

| Event | Name | Required config | Description |
|---|---|---|---|
| `"new-deal"` | New Deal Received Trigger | — | Triggered when a new deal is created in Pipedrive |
| `"new-note"` | New Note Received Trigger | — | Triggered when a new note is created in Pipedrive |
| `"new-organization"` | New Organization Received Trigger | — | Triggered when a new organization is created in Pipedrive |

## Docs

- [run CLI](https://docs.boxd.sh/cli/run): Call connected integrations from the shell, connect new ones, and run automations.
- [Quickstart](https://docs.boxd.sh/guides/integrations/quickstart): Connect an integration, call it from the shell, and turn a script into an automation.
- [Connections](https://docs.boxd.sh/guides/integrations/connections): Connect an account once, for yourself or for your whole organization.
- [Scripts](https://docs.boxd.sh/guides/automations/scripts): Typed integrations, triggers, schedules and state in a .run.ts file.
- [Jobs](https://docs.boxd.sh/guides/automations/jobs): How a script becomes a background job: states, retries, sleep and wake.
- [Beyond the catalog](https://docs.boxd.sh/guides/automations/beyond-the-catalog): Reach your own APIs, databases and cloud accounts from a script.