Pipedrive

pipedrive

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

CRM Sales & CRM Web del proveedor

Acciones

275

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (275)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add a call logPIPEDRIVE_ADD_A_CALL_LOGAcción

Adds a new call log.

Parámetros de entrada

notestring
The note for the call log in HTML format
org_idinteger
The ID of the organization this call is associated with
deal_idinteger
The ID of the deal this call is associated with. A call log can be associated with either a deal or a lead, but not both at once.
lead_idstringuuid
The ID of the lead in the UUID format this call is associated with. A call log can be associated with either a deal or a lead, but not both at once.
outcomestringObligatorioenum
Describes the outcome of the call
connectedno_answerleft_messageleft_voicemailwrong_numberbusy
subjectstring
The name of the activity this call is attached to
user_idinteger
The ID of the owner of the call log. Please note that a user without account settings access cannot create call logs for other users.
durationstring
The duration of the call in seconds
end_timestringObligatoriodate-time
The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS.
person_idinteger
The ID of the person this call is associated with
start_timestringObligatoriodate-time
The date and time of the start of the call in UTC. Format: YYYY-MM-DD HH:MM:SS.
activity_idinteger
If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don"t need to specify `deal_id`, `person_id` or `org_id`, as they will be ignored in favor of the values already available in the activity. The `activity_id` must refer to a `call` type activity.
to_phone_numberstringObligatorio
The number called
from_phone_numberstring
The number that made the call

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a channelPIPEDRIVE_ADD_A_CHANNELAcción

New messaging channel added; registration limited to admins. utilizes getconversations endpoint for data retrieval. requires messengers integration oauth scope and a prepared messaging app extension manifest.

Parámetros de entrada

namestringObligatorio
The name of the channel
avatar_urlstringurl
The URL for an icon that represents your channel
provider_typestringenum
It controls the icons (like the icon next to the conversation)
facebookwhatsappother
template_supportboolean
If true, enables templates logic on UI. Requires getTemplates endpoint implemented. Find out more [here](https://pipedrive.readme.io/docs/implementing-messaging-app-extension).
provider_channel_idstringObligatorio
The channel ID

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a comment to a notePIPEDRIVE_ADD_A_COMMENT_TO_A_NOTEAcción

Adds a new comment to a note.

Parámetros de entrada

idintegerObligatorio
The ID of the note
contentstringObligatorio
The content of the comment in HTML format. Subject to sanitization on the back-end.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a dealPIPEDRIVE_ADD_A_DEALAcción

Add a new deal to pipedrive with any custom fields, which vary by account and are identified by long hash keys. check dealfields for existing custom fields. for details, visit the tutorial on adding a deal.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a follower to a dealPIPEDRIVE_ADD_A_FOLLOWER_TO_A_DEALAcción

Adds a follower to a deal.

Parámetros de entrada

idintegerObligatorio
The ID of the deal
user_idintegerObligatorio
The ID of the user

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a follower to an organizationPIPEDRIVE_ADD_A_FOLLOWER_TO_AN_ORGANIZATIONAcción

Adds a follower to an organization.

Parámetros de entrada

idintegerObligatorio
The ID of the organization
user_idintegerObligatorio
The ID of the user

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a follower to a personPIPEDRIVE_ADD_A_FOLLOWER_TO_A_PERSONAcción

Adds a follower to a person.

Parámetros de entrada

idintegerObligatorio
The ID of the person
user_idintegerObligatorio
The ID of the user

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a follower to a productPIPEDRIVE_ADD_A_FOLLOWER_TO_A_PRODUCTAcción

Adds a follower to a product.

Parámetros de entrada

idintegerObligatorio
The ID of the product
user_idintegerObligatorio
The ID of the user

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a leadPIPEDRIVE_ADD_A_LEADAcción

Pipedrive api lets you add leads linked to people or organizations and tags them with 'api' source. custom fields from deals apply to leads and appear in responses if set. details are in the tutorials for adding and updating leads.

Parámetros de entrada

titlestringObligatorio
The name of the lead
owner_idinteger
The ID of the user which will be the owner of the created lead. If not provided, the user making the request will be used.
was_seenboolean
A flag indicating whether the lead was seen by someone in the Pipedrive UI
label_idsstring[]
The IDs of the lead labels which will be associated with the lead
person_idinteger
The ID of a person which this lead will be linked to. If the person does not exist yet, it needs to be created first. This property is required unless `organization_id` is specified.
value__amountinteger
Amount
organization_idinteger
The ID of an organization which this lead will be linked to. If the organization does not exist yet, it needs to be created first. This property is required unless `person_id` is specified.
value__currencystring
Currency
expected_close_datestringdate
The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a lead labelPIPEDRIVE_ADD_A_LEAD_LABELAcción

Creates a lead label.

Parámetros de entrada

namestringObligatorio
The name of the lead label
colorstringObligatorioenum
The color of the label. Only a subset of colors can be used.
greenblueredyellowpurplegray

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add an activityPIPEDRIVE_ADD_AN_ACTIVITYAcción

New activity added. response includes `more activities scheduled in context` to show if more are planned with the same entity. see tutorial on adding activities [here](https://pipedrive.readme.io/docs/adding-an-activity).

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a new deal fieldPIPEDRIVE_ADD_A_NEW_DEAL_FIELDAcción

Adds a new deal field. for more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-new-custom-field" target=" blank" rel="noopener noreferrer">adding a new custom field</a>.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a new filterPIPEDRIVE_ADD_A_NEW_FILTERAcción

New filter creation returns an id. only one primary condition group with 'and' and two secondary groups (one 'and', one 'or') are supported. future syntax expansion possible. see tutorial for details.

Parámetros de entrada

namestringObligatorio
The name of the filter

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a new goalPIPEDRIVE_ADD_A_NEW_GOALAcción

Adds a new goal. along with adding a new goal, a report is created to track the progress of your goal.

Parámetros de entrada

titlestring
The title of the goal
intervalstringObligatorioenum
The interval of the goal
weeklymonthlyquarterlyyearly

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a new organization fieldPIPEDRIVE_ADD_A_NEW_ORGANIZATION_FIELDAcción

Adds a new organization field. for more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-new-custom-field" target=" blank" rel="noopener noreferrer">adding a new custom field</a>.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a new person fieldPIPEDRIVE_ADD_A_NEW_PERSON_FIELDAcción

Adds a new person field. for more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-new-custom-field" target=" blank" rel="noopener noreferrer">adding a new custom field</a>.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a new pipelinePIPEDRIVE_ADD_A_NEW_PIPELINEAcción

Adds a new pipeline.

Parámetros de entrada

namestringObligatorio
The name of the pipeline
order_nrinteger
Defines the order of pipelines. First order (`order_nr=0`) is the default pipeline.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a new product fieldPIPEDRIVE_ADD_A_NEW_PRODUCT_FIELDAcción

Adds a new product field. for more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-new-custom-field" target=" blank" rel="noopener noreferrer">adding a new custom field</a>.

Parámetros de entrada

namestringObligatorio
The name of the field
optionsobject[]
When `field_type` is either `set` or `enum`, possible options must be supplied as a JSON-encoded sequential array, for example:</br>`[{"label":"red"}, {"label":"blue"}, {"label":"lilac"}]`
field_typestringObligatorioenum
The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a product ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field (autocompleted by Google Maps)</dd></table>
varcharvarchar_autotextdoublemonetarydatesetenumuserorgpeoplephone+4

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a new stagePIPEDRIVE_ADD_A_NEW_STAGEAcción

Adds a new stage, returns the id upon success.

Parámetros de entrada

namestringObligatorio
The name of the stage
pipeline_idintegerObligatorio
The ID of the pipeline to add stage to
rotten_daysinteger
The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set.
rotten_flagboolean
Whether deals in this stage can become rotten
deal_probabilityinteger
The success probability percentage of the deal. Used/shown when deal weighted values are used.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a new teamPIPEDRIVE_ADD_A_NEW_TEAMAcción

Adds a new team to the company and returns the created object.

Parámetros de entrada

namestringObligatorio
The team name
usersinteger[]
The list of user IDs
manager_idintegerObligatorio
The team manager ID
descriptionstring
The team description

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a new userPIPEDRIVE_ADD_A_NEW_USERAcción

Adds a new user to the company, returns the id upon success.

Parámetros de entrada

emailstringObligatorio
The email of the user
accessobject[]
The access given to the user. Each item in the array represents access to a specific app. Optionally may include either admin flag or permission set ID to specify which access to give within the app. If both are omitted, the default access for the corresponding app will be used. It requires structure as follows: `[{ app: "sales", permission_set_id: "62cc4d7f-4038-4352-abf3-a8c1c822b631" }, { app: "global", admin: true }, { app: "account_settings" }]`
active_flagboolean
Whether the user is active or not. `false` = Not activated, `true` = Activated

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add an installment subscriptionPIPEDRIVE_ADD_AN_INSTALLMENT_SUBSCRIPTIONAcción

Adds a new installment subscription.

Parámetros de entrada

deal_idintegerObligatorio
The ID of the deal this installment subscription is associated with
currencystringObligatorio
The currency of the installment subscription. Accepts a 3-character currency code.
paymentsobject[]Obligatorio
Array of payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).
update_deal_valueboolean
Indicates that the deal value must be set to the installment subscription"s total value

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add an organizationPIPEDRIVE_ADD_AN_ORGANIZATIONAcción

Set up a new pipedrive organization using custom fields with unique key hashes. retrieve `organizationfields` for configuration. check the linked tutorial for guidance.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a notePIPEDRIVE_ADD_A_NOTEAcción

Add a note to a deal, person, organization, lead, or project in pipedrive. at least one of deal id, person id, org id, lead id, or project id must be provided.

Parámetros de entrada

org_idinteger
The ID of the organization this note will be attached to. Required unless one of (deal_id/person_id/lead_id/project_id) is specified.
contentstringObligatorio
The content of the note in HTML format. Subject to sanitization on the back-end.
deal_idinteger
The ID of the deal the note will be attached to. Required unless one of (lead_id/person_id/org_id/project_id) is specified.
lead_idstring
The ID of the lead the note will be attached to (UUID format). Required unless one of (deal_id/person_id/org_id/project_id) is specified.
add_timestring
The optional creation date & time of the note in UTC. Format: YYYY-MM-DD HH:MM:SS
person_idinteger
The ID of the person this note will be attached to. Required unless one of (deal_id/lead_id/org_id/project_id) is specified.
project_idinteger
The ID of the project the note will be attached to. Required unless one of (deal_id/person_id/org_id/lead_id) is specified.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a participant to a dealPIPEDRIVE_ADD_A_PARTICIPANT_TO_A_DEALAcción

Adds a participant to a deal.

Parámetros de entrada

idintegerObligatorio
The ID of the deal
person_idintegerObligatorio
The ID of the person

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a personPIPEDRIVE_ADD_A_PERSONAcción

Add a new contact in pipedrive with optional custom fields unique to each account found using the `personfields` endpoint. the endpoint also handles `data.marketing status` for campaigns product users.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a productPIPEDRIVE_ADD_A_PRODUCTAcción

Adds a new product to the products inventory. for more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-product" target=" blank" rel="noopener noreferrer">adding a product</a>.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a product to a dealPIPEDRIVE_ADD_A_PRODUCT_TO_A_DEALAcción

Adds a product to a deal, creating a new item called a deal-product.

Parámetros de entrada

idintegerObligatorio
The ID of the deal

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a projectPIPEDRIVE_ADD_A_PROJECTAcción

Adds a new project. note that you can supply additional custom fields along with the request that are not described here. these custom fields are different for each pipedrive account and can be recognized by long hashes as keys.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a recurring subscriptionPIPEDRIVE_ADD_A_RECURRING_SUBSCRIPTIONAcción

Adds a new recurring subscription.

Parámetros de entrada

deal_idintegerObligatorio
The ID of the deal this recurring subscription is associated with
currencystringObligatorio
The currency of the recurring subscription. Accepts a 3-character currency code.
infiniteboolean
This indicates that the recurring subscription will last until it"s manually canceled or deleted. Note that only one field must be set: `cycles_count` or `infinite`.
paymentsobject[]
Array of additional payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).
start_datestringObligatoriodate
The start date of the recurring subscription. Format: YYYY-MM-DD
descriptionstring
The description of the recurring subscription
cadence_typestringObligatorioenum
The interval between payments
weeklymonthlyquarterlyyearly
cycle_amountintegerObligatorio
The amount of each payment
cycles_countinteger
Shows how many payments the subscription has. Note that one field must be set: `cycles_count` or `infinite`. If `cycles_count` is set, then `cycle_amount` and `start_date` are also required.
update_deal_valueboolean
Indicates that the deal value must be set to recurring subscription"s MRR value

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a rolePIPEDRIVE_ADD_A_ROLEAcción

Adds a new role.

Parámetros de entrada

namestringObligatorio
The name of the role
parent_role_idinteger
The ID of the parent role

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a taskPIPEDRIVE_ADD_A_TASKAcción

Adds a new task.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add filePIPEDRIVE_ADD_FILEAcción

Upload and link files to deals, people, organizations, activities, products, or leads in pipedrive. see the "adding a file" tutorial for details.

Parámetros de entrada

fileobjectbinary
File
org_idinteger
Org Id
deal_idinteger
Deal Id
lead_idobjectuuid
Lead Id
person_idinteger
Person Id
product_idinteger
Product Id
activity_idinteger
Activity Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add new activity typePIPEDRIVE_ADD_NEW_ACTIVITY_TYPEAcción

Adds a new activity type.

Parámetros de entrada

namestringObligatorio
The name of the activity type
colorstring
A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black)
icon_keystringObligatorioenum
Icon graphic to use for representing this activity type
taskemailmeetingdeadlinecalllunchcalendardownarrowdocumentsmartphonecamerascissors+28

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add or update role settingPIPEDRIVE_ADD_OR_UPDATE_ROLE_SETTINGAcción

Adds or updates the visibility setting for a role.

Parámetros de entrada

idintegerObligatorio
The ID of the role
valueintegerObligatorio
Possible values for the `default_visibility` setting depending on the subscription plan:<br> <table class="role-setting"> <caption><b>Essential / Advanced plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner & Followers</td></tr> <tr><td>`3`</td><td>Entire company</td></tr> </table> <br> <table class="role-setting"> <caption><b>Professional / Enterprise plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner only</td></tr> <tr><td>`3`</td><td>Owner's visibility group</td></tr> <tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr> <tr><td>`7`</td><td>Entire company</td></tr> </table> <br> Read more about visibility groups <a href="https://support.pipedrive.com/en/article/visibility-groups">here</a>.
setting_keystringObligatorioenum
Setting Key
deal_default_visibilitylead_default_visibilityorg_default_visibilityperson_default_visibilityproduct_default_visibility

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add person picturePIPEDRIVE_ADD_PERSON_PICTUREAcción

This service allows adding a photo to a person's profile, replacing any existing one. images must be square with a minimum size of 128 pixels and in gif, jpg, or png formats. they will be resized to 128 and 512 pixels.

Parámetros de entrada

idintegerObligatorio
The ID of the person
fileobjectbinary
File
crop_xinteger
Crop X
crop_yinteger
Crop Y
crop_widthinteger
Crop Width
crop_heightinteger
Crop Height

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add role assignmentPIPEDRIVE_ADD_ROLE_ASSIGNMENTAcción

Assigns a user to a role.

Parámetros de entrada

idintegerObligatorio
The ID of the role
user_idintegerObligatorio
The ID of the user

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add users to a teamPIPEDRIVE_ADD_USERS_TO_A_TEAMAcción

Adds users to an existing team.

Parámetros de entrada

idintegerObligatorio
The ID of the team
usersinteger[]Obligatorio
The list of user IDs

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive a projectPIPEDRIVE_ARCHIVE_A_PROJECTAcción

Archives a project.

Parámetros de entrada

idintegerObligatorio
The ID of the project

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Attach an audio file to the call logPIPEDRIVE_ATTACH_AN_AUDIO_FILE_TO_THE_CALL_LOGAcción

Adds an audio recording to the call log. that audio can be played by those who have access to the call log object.

Parámetros de entrada

idstringObligatorio
The ID received when you create the call log
fileobjectbinary
File

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Cancel a recurring subscriptionPIPEDRIVE_CANCEL_A_RECURRING_SUBSCRIPTIONAcción

Cancels a recurring subscription.

Parámetros de entrada

idintegerObligatorio
The ID of the subscription
end_datestringdate
The subscription termination date. All payments after the specified date will be deleted. The end_date of the subscription will be set to the due date of the payment to follow the specified date. Default value is the current date.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a new webhookPIPEDRIVE_CREATE_A_NEW_WEBHOOKAcción

Creates and returns details of a new webhook. trigger events combine `event action` and `event object`, like `*.*` for all events or `added.deal`, `deleted.persons` for specific actions. more info in the webhooks guide.

Parámetros de entrada

user_idinteger
The ID of the user that this webhook will be authorized with. You have the option to use a different user"s `user_id`. If it is not set, the current user"s `user_id` will be used. As each webhook event is checked against a user"s permissions, the webhook will only be sent if the user has access to the specified object(s). If you want to receive notifications for all events, please use a top-level admin user’s `user_id`.
versionstringenum
The webhook"s version
1.02.0
event_actionstringObligatorioenum
The type of action to receive notifications about. Wildcard will match all supported actions.
addedupdatedmergeddeleted*
event_objectstringObligatorioenum
The type of object to receive notifications about. Wildcard will match all supported objects.
activityactivityTypedealnoteorganizationpersonpipelineproductstageuser*
http_auth_userstring
The HTTP basic auth username of the subscription URL endpoint (if required)
subscription_urlstringObligatorio
A full, valid, publicly accessible URL which determines where to send the notifications. Please note that you cannot use Pipedrive API endpoints as the `subscription_url` and the chosen URL must not redirect to another link.
http_auth_passwordstring
The HTTP basic auth password of the subscription URL endpoint (if required)

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create an organization relationshipPIPEDRIVE_CREATE_AN_ORGANIZATION_RELATIONSHIPAcción

Creates and returns an organization relationship.

Parámetros de entrada

typestringObligatorioenum
The type of organization relationship
parentrelated
org_idinteger
The ID of the base organization for the returned calculated values
rel_owner_org_idintegerObligatorio
The owner of the relationship. If type is `parent`, then the owner is the parent and the linked organization is the daughter.
rel_linked_org_idintegerObligatorio
The linked organization in the relationship. If type is `parent`, then the linked organization is the daughter.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a remote file and link it to an itemPIPEDRIVE_CREATE_A_REMOTE_FILE_AND_LINK_IT_TO_AN_ITEMAcción

Creates an empty file on google drive linked to an item. for details, refer to the pipedrive remote file adding tutorial.

Parámetros de entrada

titlestringObligatorio
The title of the file
item_idintegerObligatorio
The ID of the item to associate the file with
file_typestringObligatorioenum
The file type
gdocgslidesgsheetgformgdraw
item_typestringObligatorioenum
The item type
dealorganizationperson
remote_locationstringObligatorioenum
The location type to send the file to. Only `googledrive` is supported at the moment.
googledrive

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a call logPIPEDRIVE_DELETE_A_CALL_LOGAcción

Deletes a call log. if there is an audio recording attached to it, it will also be deleted. the related activity will not be removed by this request. if you want to remove the related activities, please use the endpoint which is specific for activities.

Parámetros de entrada

idstringObligatorio
The ID received when you create the call log

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a channelPIPEDRIVE_DELETE_A_CHANNELAcción

The endpoint removes a messenger channel along with conversations and messages. requires messengers integration oauth and messaging app extension manifest.

Parámetros de entrada

idstringObligatorio
The ID of the channel provided by the integration

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a comment related to a notePIPEDRIVE_DELETE_A_COMMENT_RELATED_TO_A_NOTEAcción

Deletes a comment.

Parámetros de entrada

idintegerObligatorio
The ID of the note
commentIdstringObligatorio
The ID of the comment

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a conversationPIPEDRIVE_DELETE_A_CONVERSATIONAcción

Deletes an existing conversation. to use the endpoint, you need to have **messengers integration** oauth scope enabled and the messaging manifest ready for the [messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).

Parámetros de entrada

channel__idstringObligatorio
The ID of the channel provided by the integration
conversation__idstringObligatorio
The ID of the conversation provided by the integration

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a dealPIPEDRIVE_DELETE_A_DEALAcción

Marks a deal as deleted. after 30 days, the deal will be permanently deleted.

Parámetros de entrada

idintegerObligatorio
The ID of the deal

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a deal fieldPIPEDRIVE_DELETE_A_DEAL_FIELDAcción

Marks a field as deleted. for more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/deleting-a-custom-field" target=" blank" rel="noopener noreferrer">deleting a custom field</a>.

Parámetros de entrada

idintegerObligatorio
The ID of the field

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a filePIPEDRIVE_DELETE_A_FILEAcción

Marks a file as deleted. after 30 days, the file will be permanently deleted.

Parámetros de entrada

idintegerObligatorio
The ID of the file

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a filterPIPEDRIVE_DELETE_A_FILTERAcción

Marks a filter as deleted.

Parámetros de entrada

idintegerObligatorio
The ID of the filter

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a follower from a dealPIPEDRIVE_DELETE_A_FOLLOWER_FROM_A_DEALAcción

Deletes a follower from a deal.

Parámetros de entrada

idintegerObligatorio
The ID of the deal
follower_idintegerObligatorio
The ID of the follower

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a follower from an organizationPIPEDRIVE_DELETE_A_FOLLOWER_FROM_AN_ORGANIZATIONAcción

Deletes a follower from an organization. you can retrieve the `follower id` from the <a href="https://developers.pipedrive.com/docs/api/v1/organizations#getorganizationfollowers">list followers of an organization</a> endpoint.

Parámetros de entrada

idintegerObligatorio
The ID of the organization
follower_idintegerObligatorio
The ID of the follower

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a follower from a personPIPEDRIVE_DELETE_A_FOLLOWER_FROM_A_PERSONAcción

Deletes a follower from a person.

Parámetros de entrada

idintegerObligatorio
The ID of the person
follower_idintegerObligatorio
The ID of the follower

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a follower from a productPIPEDRIVE_DELETE_A_FOLLOWER_FROM_A_PRODUCTAcción

Deletes a follower from a product.

Parámetros de entrada

idintegerObligatorio
The ID of the product
follower_idintegerObligatorio
The ID of the relationship between the follower and the product

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a leadPIPEDRIVE_DELETE_A_LEADAcción

Deletes a specific lead.

Parámetros de entrada

idstringObligatorio
The ID of the lead

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a lead labelPIPEDRIVE_DELETE_A_LEAD_LABELAcción

Deletes a specific lead label.

Parámetros de entrada

idstringObligatorio
The ID of the lead label

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete an activityPIPEDRIVE_DELETE_AN_ACTIVITYAcción

Marks an activity as deleted. after 30 days, the activity will be permanently deleted.

Parámetros de entrada

idintegerObligatorio
The ID of the activity

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete an activity typePIPEDRIVE_DELETE_AN_ACTIVITY_TYPEAcción

Marks an activity type as deleted.

Parámetros de entrada

idintegerObligatorio
The ID of the activity type

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete an attached product from a dealPIPEDRIVE_DELETE_AN_ATTACHED_PRODUCT_FROM_A_DEALAcción

Deletes a product attachment from a deal, using the `product attachment id`.

Parámetros de entrada

idintegerObligatorio
The ID of the deal
product_attachment_idintegerObligatorio
The product attachment ID

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete an organizationPIPEDRIVE_DELETE_AN_ORGANIZATIONAcción

Marks an organization as deleted. after 30 days, the organization will be permanently deleted.

Parámetros de entrada

idintegerObligatorio
The ID of the organization

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete an organization fieldPIPEDRIVE_DELETE_AN_ORGANIZATION_FIELDAcción

Parámetros de entrada

idintegerObligatorio
The ID of the field

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete an organization relationshipPIPEDRIVE_DELETE_AN_ORGANIZATION_RELATIONSHIPAcción

Deletes an organization relationship and returns the deleted id.

Parámetros de entrada

idintegerObligatorio
The ID of the organization relationship

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a notePIPEDRIVE_DELETE_A_NOTEAcción

Deletes a specific note.

Parámetros de entrada

idintegerObligatorio
The ID of the note

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a participant from a dealPIPEDRIVE_DELETE_A_PARTICIPANT_FROM_A_DEALAcción

Deletes a participant from a deal.

Parámetros de entrada

idintegerObligatorio
The ID of the deal
deal_participant_idintegerObligatorio
The ID of the participant of the deal

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a personPIPEDRIVE_DELETE_A_PERSONAcción

Marks a person as deleted. after 30 days, the person will be permanently deleted.

Parámetros de entrada

idintegerObligatorio
The ID of the person

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a person fieldPIPEDRIVE_DELETE_A_PERSON_FIELDAcción

Parámetros de entrada

idintegerObligatorio
The ID of the field

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a pipelinePIPEDRIVE_DELETE_A_PIPELINEAcción

Marks a pipeline as deleted.

Parámetros de entrada

idintegerObligatorio
The ID of the pipeline

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a productPIPEDRIVE_DELETE_A_PRODUCTAcción

Marks a product as deleted. after 30 days, the product will be permanently deleted.

Parámetros de entrada

idintegerObligatorio
The ID of the product

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a product fieldPIPEDRIVE_DELETE_A_PRODUCT_FIELDAcción

Marks a product field as deleted. for more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/deleting-a-custom-field" target=" blank" rel="noopener noreferrer">deleting a custom field</a>.

Parámetros de entrada

idintegerObligatorio
The ID of the product field

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a projectPIPEDRIVE_DELETE_A_PROJECTAcción

Marks a project as deleted.

Parámetros de entrada

idintegerObligatorio
The ID of the project

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a rolePIPEDRIVE_DELETE_A_ROLEAcción

Marks a role as deleted.

Parámetros de entrada

idintegerObligatorio
The ID of the role

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a role assignmentPIPEDRIVE_DELETE_A_ROLE_ASSIGNMENTAcción

Removes the assigned user from a role and adds to the default role.

Parámetros de entrada

idintegerObligatorio
The ID of the role
user_idintegerObligatorio
The ID of the user

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a stagePIPEDRIVE_DELETE_A_STAGEAcción

Marks a stage as deleted.

Parámetros de entrada

idintegerObligatorio
The ID of the stage

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a subscriptionPIPEDRIVE_DELETE_A_SUBSCRIPTIONAcción

Marks an installment or a recurring subscription as deleted.

Parámetros de entrada

idintegerObligatorio
The ID of the subscription

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a taskPIPEDRIVE_DELETE_A_TASKAcción

Marks a task as deleted. if the task has subtasks then those will also be deleted.

Parámetros de entrada

idintegerObligatorio
The ID of the task

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete existing goalPIPEDRIVE_DELETE_EXISTING_GOALAcción

Marks a goal as deleted.

Parámetros de entrada

idstringObligatorio
The ID of the goal

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete existing webhookPIPEDRIVE_DELETE_EXISTING_WEBHOOKAcción

Deletes the specified webhook.

Parámetros de entrada

idintegerObligatorio
The ID of the Webhook to delete

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete mail threadPIPEDRIVE_DELETE_MAIL_THREADAcción

Marks a mail thread as deleted.

Parámetros de entrada

idintegerObligatorio
The ID of the mail thread

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete multiple activities in bulkPIPEDRIVE_DELETE_MULTIPLE_ACTIVITIES_IN_BULKAcción

Marks multiple activities as deleted. after 30 days, the activities will be permanently deleted.

Parámetros de entrada

idsstringObligatorio
The comma-separated IDs of activities that will be deleted

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete multiple activity types in bulkPIPEDRIVE_DELETE_MULTIPLE_ACTIVITY_TYPES_IN_BULKAcción

Marks multiple activity types as deleted.

Parámetros de entrada

idsstringObligatorio
The comma-separated activity type IDs

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete multiple deal fields in bulkPIPEDRIVE_DELETE_MULTIPLE_DEAL_FIELDS_IN_BULKAcción

Marks multiple deal fields as deleted.

Parámetros de entrada

idsstringObligatorio
The comma-separated field IDs to delete

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete multiple deals in bulkPIPEDRIVE_DELETE_MULTIPLE_DEALS_IN_BULKAcción

Marks multiple deals as deleted. after 30 days, the deals will be permanently deleted.

Parámetros de entrada

idsstringObligatorio
The comma-separated IDs that will be deleted

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete multiple filters in bulkPIPEDRIVE_DELETE_MULTIPLE_FILTERS_IN_BULKAcción

Marks multiple filters as deleted.

Parámetros de entrada

idsstringObligatorio
The comma-separated filter IDs to delete

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete multiple organization fields in bulkPIPEDRIVE_DELETE_MULTIPLE_ORGANIZATION_FIELDS_IN_BULKAcción

Marks multiple fields as deleted.

Parámetros de entrada

idsstringObligatorio
The comma-separated field IDs to delete

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete multiple organizations in bulkPIPEDRIVE_DELETE_MULTIPLE_ORGANIZATIONS_IN_BULKAcción

Marks multiple organizations as deleted. after 30 days, the organizations will be permanently deleted.

Parámetros de entrada

idsstringObligatorio
The comma-separated IDs that will be deleted

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete multiple person fields in bulkPIPEDRIVE_DELETE_MULTIPLE_PERSON_FIELDS_IN_BULKAcción

Marks multiple fields as deleted.

Parámetros de entrada

idsstringObligatorio
The comma-separated field IDs to delete

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete multiple persons in bulkPIPEDRIVE_DELETE_MULTIPLE_PERSONS_IN_BULKAcción

Marks multiple persons as deleted. after 30 days, the persons will be permanently deleted.

Parámetros de entrada

idsstringObligatorio
The comma-separated IDs that will be deleted

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete multiple product fields in bulkPIPEDRIVE_DELETE_MULTIPLE_PRODUCT_FIELDS_IN_BULKAcción

Marks multiple fields as deleted.

Parámetros de entrada

idsstringObligatorio
The comma-separated field IDs to delete

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete multiple stages in bulkPIPEDRIVE_DELETE_MULTIPLE_STAGES_IN_BULKAcción

Marks multiple stages as deleted.

Parámetros de entrada

idsstringObligatorio
The comma-separated stage IDs to delete

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete person picturePIPEDRIVE_DELETE_PERSON_PICTUREAcción

Deletes a person’s picture.

Parámetros de entrada

idintegerObligatorio
The ID of the person

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete users from a teamPIPEDRIVE_DELETE_USERS_FROM_A_TEAMAcción

Deletes users from an existing team.

Parámetros de entrada

idintegerObligatorio
The ID of the team
usersinteger[]Obligatorio
The list of user IDs

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Download one filePIPEDRIVE_DOWNLOAD_ONE_FILEAcción

Initializes a file download.

Parámetros de entrada

idintegerObligatorio
The ID of the file

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Duplicate dealPIPEDRIVE_DUPLICATE_DEALAcción

Duplicates a deal.

Parámetros de entrada

idintegerObligatorio
The ID of the deal

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Enumerate accessible users for leadPIPEDRIVE_ENUMERATE_ACCESSIBLE_USERS_FOR_LEADAcción

Lists the users permitted to access a lead.

Parámetros de entrada

idstringObligatorio
The ID of the lead

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Find goalsPIPEDRIVE_FIND_GOALSAcción

Query goal data by appending `{searchfield}={searchvalue}` to the url with dot-notation fields and values. include `is active` to filter by goal status and specify both `period.start` and `period.end` for time-based searches.

Parámetros de entrada

titlestring
The title of the goal
is_activeboolean
Whether the goal is active or not
type__namestringenum
The type of the goal. If provided, everyone"s goals will be returned.
deals_wondeals_progressedactivities_completedactivities_addeddeals_started
period__endstring
The end date of the period for which to find goals. Date in format of YYYY-MM-DD.
assignee__idinteger
The ID of the user who"s goal to fetch. When omitted, only your goals will be returned.
period__startstring
The start date of the period for which to find goals. Date in format of YYYY-MM-DD. When `period.start` is provided, `period.end` must be provided too.
assignee__typestringenum
The type of the goal"s assignee. If provided, everyone"s goals will be returned.
personcompanyteam
type__params__stage__idinteger
The ID of the stage. Applicable to only `deals_progressed` type of goals. If provided, everyone"s goals will be returned.
expected__outcome__targetinteger
The numeric value of the outcome. If provided, everyone"s goals will be returned.
type__params__pipeline__idinteger[]
An array of pipeline IDs or `null` for all pipelines. If provided, everyone"s goals will be returned.
expected__outcome__currency__idinteger
The numeric ID of the goal"s currency. Only applicable to goals with `expected_outcome.tracking_metric` with value `sum`. If provided, everyone"s goals will be returned.
type__params__activity__type__idinteger[]
An array of IDs or `null` for all activity types. Only applicable for `activities_completed` and/or `activities_added` types of goals. If provided, everyone"s goals will be returned.
expected__outcome__tracking__metricstringenum
The tracking metric of the expected outcome of the goal. If provided, everyone"s goals will be returned.
quantitysum

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Find subscription by dealPIPEDRIVE_FIND_SUBSCRIPTION_BY_DEALAcción

Returns details of an installment or a recurring subscription by the deal id.

Parámetros de entrada

dealIdintegerObligatorio
The ID of the deal

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Find users by namePIPEDRIVE_FIND_USERS_BY_NAMEAcción

Finds users by their name.

Parámetros de entrada

termstringObligatorio
The search term to look for
search_by_emailinteger
When enabled, the term will only be matched against email addresses of users. Default: `false`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all activities assigned to a particular userPIPEDRIVE_GET_ALL_ACTIVITIES_ASSIGNED_TO_A_PARTICULAR_USERAcción

Returns all activities assigned to a particular user.

Parámetros de entrada

doneinteger
Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both done and not done activities.
typestring
The type of the activity, can be one type or multiple types separated by a comma. This is in correlation with the `key_string` parameter of ActivityTypes.
limitinteger
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
startinteger
For pagination, the position that represents the first result for the page
user_idinteger
The ID of the user whose activities will be fetched. If omitted, the user associated with the API token will be used. If 0, activities for all company users will be fetched based on the permission sets.
end_datestring
Use the activity due date where you wish to stop fetching activities from. Insert due date in YYYY-MM-DD format.
filter_idinteger
The ID of the filter to use (will narrow down results if used together with `user_id` parameter)
start_datestring
Use the activity due date where you wish to begin fetching activities from. Insert due date in YYYY-MM-DD format.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all activities betaPIPEDRIVE_GET_ALL_ACTIVITIES_BETAAcción

This beta cursor-paginated endpoint returns all activities, accessible only to global admins, not regular users who get a 403 error. refer to pipedrive's documentation for pagination and global permissions.

Parámetros de entrada

doneboolean
Whether the activity is done or not. `false` = Not done, `true` = Done. If omitted, returns both done and not done activities.
typestring
The type of the activity, can be one type or multiple types separated by a comma. This is in correlation with the `key_string` parameter of ActivityTypes.
limitinteger
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
sincestring
The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
untilstring
The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
cursorstring
For pagination, the marker (an opaque string value) representing the first item on the next page
user_idinteger
The ID of the user whose activities will be fetched. If omitted, all activities are returned.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all activity fieldsPIPEDRIVE_GET_ALL_ACTIVITY_FIELDSAcción

Returns all activity fields.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all activity typesPIPEDRIVE_GET_ALL_ACTIVITY_TYPESAcción

Returns all activity types.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all add ons for a single companyPIPEDRIVE_GET_ALL_ADD_ONS_FOR_A_SINGLE_COMPANYAcción

Returns the add-ons for a single company.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all call logs assigned to a particular userPIPEDRIVE_GET_ALL_CALL_LOGS_ASSIGNED_TO_A_PARTICULAR_USERAcción

Returns all call logs assigned to a particular user.

Parámetros de entrada

limitinteger
For pagination, the limit of entries to be returned. The upper limit is 50.
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all comments for a notePIPEDRIVE_GET_ALL_COMMENTS_FOR_A_NOTEAcción

Returns all comments associated with a note.

Parámetros de entrada

idintegerObligatorio
The ID of the note
limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all deal fieldsPIPEDRIVE_GET_ALL_DEAL_FIELDSAcción

Returns data about all deal fields.

Parámetros de entrada

limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all dealsPIPEDRIVE_GET_ALL_DEALSAcción

Returns all deals. for more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/getting-all-deals" target=" blank" rel="noopener noreferrer">getting all deals</a>.

Parámetros de entrada

sortstring
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
limitinteger
Items shown per page
startinteger
Pagination start
statusstringenum
Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.
openwonlostdeletedall_not_deleted
user_idinteger
If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied.
stage_idinteger
If supplied, only deals within the given stage will be returned
filter_idinteger
The ID of the filter to use
owned_by_youinteger
When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all deals betaPIPEDRIVE_GET_ALL_DEALS_BETAAcción

This endpoint returns all deals with cursor pagination (in beta). only global admins can access it; others get a 403 error. more info on pagination and permissions is available online.

Parámetros de entrada

limitinteger
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
sincestring
The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
untilstring
The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
cursorstring
For pagination, the marker (an opaque string value) representing the first item on the next page
statusstringenum
Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.
openwonlostdeleted
user_idinteger
If supplied, only deals matching the given user will be returned
stage_idinteger
If supplied, only deals within the given stage will be returned

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all filesPIPEDRIVE_GET_ALL_FILESAcción

Returns data about all files.

Parámetros de entrada

sortstring
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all filter helpersPIPEDRIVE_GET_ALL_FILTER_HELPERSAcción

The text provides links to documentation for adding or updating filters, and information on all supported filter helpers in an api. it encourages consulting a tutorial for more details on adding a filter.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all filtersPIPEDRIVE_GET_ALL_FILTERSAcción

Returns data about all filters.

Parámetros de entrada

typestringenum
The types of filters to fetch
dealsleadsorgpeopleproductsactivityprojects

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all lead labelsPIPEDRIVE_GET_ALL_LEAD_LABELSAcción

Returns details of all lead labels. this endpoint does not support pagination and all labels are always returned.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all leadsPIPEDRIVE_GET_ALL_LEADSAcción

The api returns sorted leads by creation time, supporting pagination via `limit` and `start`. custom field values are included if set, mimicking the `deals` endpoint structure; unset fields are omitted. leads share custom fields with deals.

Parámetros de entrada

sortstringenum
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
idtitleowner_idcreator_idwas_seenexpected_close_datenext_activity_idadd_timeupdate_time
limitinteger
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
startinteger
For pagination, the position that represents the first result for the page
owner_idinteger
If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.
filter_idinteger
The ID of the filter to use
person_idinteger
If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
archived_statusstringenum
Filtering based on the archived status of a lead. If not provided, `All` is used.
archivednot_archivedall
organization_idinteger
If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all lead sourcesPIPEDRIVE_GET_ALL_LEAD_SOURCESAcción

Returns all lead sources. please note that the list of lead sources is fixed, it cannot be modified. all leads created through the pipedrive api will have a lead source `api` assigned.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all mail messages of mail threadPIPEDRIVE_GET_ALL_MAIL_MESSAGES_OF_MAIL_THREADAcción

Returns all the mail messages inside a specified mail thread.

Parámetros de entrada

idintegerObligatorio
The ID of the mail thread

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all note fieldsPIPEDRIVE_GET_ALL_NOTE_FIELDSAcción

Returns data about all note fields.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all notesPIPEDRIVE_GET_ALL_NOTESAcción

Returns all notes.

Parámetros de entrada

sortstring
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`.
limitinteger
Items shown per page
startinteger
Pagination start
org_idinteger
The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned.
deal_idinteger
The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned.
lead_idstring
The ID of the lead which notes to fetch. If omitted, notes about all leads will be returned.
user_idinteger
The ID of the user whose notes to fetch. If omitted, notes by all users will be returned.
end_datestring
The date in format of YYYY-MM-DD until which notes to fetch to
person_idinteger
The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned.
start_datestring
The date in format of YYYY-MM-DD from which notes to fetch
pinned_to_deal_flaginteger
If set, the results are filtered by note to deal pinning state
pinned_to_lead_flaginteger
If set, the results are filtered by note to lead pinning state
pinned_to_person_flaginteger
If set, the results are filtered by note to person pinning state
pinned_to_organization_flaginteger
If set, the results are filtered by note to organization pinning state

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all organization fieldsPIPEDRIVE_GET_ALL_ORGANIZATION_FIELDSAcción

Returns data about all organization fields.

Parámetros de entrada

limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all organizationsPIPEDRIVE_GET_ALL_ORGANIZATIONSAcción

Returns all organizations.

Parámetros de entrada

sortstring
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
limitinteger
Items shown per page
startinteger
Pagination start
user_idinteger
If supplied, only organizations owned by the given user will be returned. However, `filter_id` takes precedence over `user_id` when both are supplied.
filter_idinteger
The ID of the filter to use
first_charstring
If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive)

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all organizations betaPIPEDRIVE_GET_ALL_ORGANIZATIONS_BETAAcción

This beta api endpoint lists all organizations with cursor pagination. only global admins have access; others get a 403 error. see docs for pagination and global permissions.

Parámetros de entrada

limitinteger
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
sincestring
The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
untilstring
The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
cursorstring
For pagination, the marker (an opaque string value) representing the first item on the next page
owner_idinteger
If supplied, only organizations owned by the given user will be returned
first_charstring
If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive)

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all payments of a subscriptionPIPEDRIVE_GET_ALL_PAYMENTS_OF_A_SUBSCRIPTIONAcción

Returns all payments of an installment or recurring subscription.

Parámetros de entrada

idintegerObligatorio
The ID of the subscription

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all permission setsPIPEDRIVE_GET_ALL_PERMISSION_SETSAcción

Returns data about all permission sets.

Parámetros de entrada

appstringenum
The app to filter the permission sets by
salesprojectscampaignsglobalaccount_settings

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all person fieldsPIPEDRIVE_GET_ALL_PERSON_FIELDSAcción

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 `data.marketing status` field.

Parámetros de entrada

limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all personsPIPEDRIVE_GET_ALL_PERSONSAcción

Returns all persons.

Parámetros de entrada

sortstring
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
limitinteger
Items shown per page
startinteger
Pagination start
user_idinteger
If supplied, only persons owned by the given user will be returned. However, `filter_id` takes precedence over `user_id` when both are supplied.
filter_idinteger
The ID of the filter to use
first_charstring
If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive)

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all persons betaPIPEDRIVE_GET_ALL_PERSONS_BETAAcción

This beta endpoint returns all persons, using cursor pagination. only global admins have access; others get a 403 error. info on pagination and permissions is in the linked docs.

Parámetros de entrada

limitinteger
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
sincestring
The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
untilstring
The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
cursorstring
For pagination, the marker (an opaque string value) representing the first item on the next page
owner_idinteger
If supplied, only persons owned by the given user will be returned
first_charstring
If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive)

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all pipelinesPIPEDRIVE_GET_ALL_PIPELINESAcción

Returns data about all pipelines.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all product fieldsPIPEDRIVE_GET_ALL_PRODUCT_FIELDSAcción

Returns data about all product fields.

Parámetros de entrada

limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all productsPIPEDRIVE_GET_ALL_PRODUCTSAcción

Returns data about all products.

Parámetros de entrada

idsinteger[]
An array of integers with the IDs of the products that should be returned in the response
limitinteger
Items shown per page
startinteger
Pagination start
user_idinteger
If supplied, only products owned by the given user will be returned
filter_idinteger
The ID of the filter to use
first_charstring
If supplied, only products whose name starts with the specified letter will be returned (case-insensitive)
get_summaryboolean
If supplied, the response will return the total numbers of products in the `additional_data.summary.total_count` property

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all project boardsPIPEDRIVE_GET_ALL_PROJECT_BOARDSAcción

Returns all projects boards that are not deleted.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all projectsPIPEDRIVE_GET_ALL_PROJECTSAcción

Returns all projects. this is a cursor-paginated endpoint. for more information, please refer to our documentation on <a href="https://pipedrive.readme.io/docs/core-api-concepts-pagination" target=" blank" rel="noopener noreferrer">pagination</a>.

Parámetros de entrada

limitinteger
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
cursorstring
For pagination, the marker (an opaque string value) representing the first item on the next page
statusstring
If supplied, includes only projects with the specified statuses. Possible values are `open`, `completed`, `canceled` and `deleted`. By default `deleted` projects are not returned.
phase_idinteger
If supplied, only projects in specified phase are returned
filter_idinteger
The ID of the filter to use
include_archivedboolean
If supplied with `true` then archived projects are also included in the response. By default only not archived projects are returned.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all project templatesPIPEDRIVE_GET_ALL_PROJECT_TEMPLATESAcción

The endpoint retrieves all non-deleted project templates with cursor-based pagination. refer to the provided documentation link for more details on pagination.

Parámetros de entrada

limitinteger
For pagination, the limit of entries to be returned. If not provided, up to 500 items will be returned.
cursorstring
For pagination, the marker (an opaque string value) representing the first item on the next page

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all relationships for organizationPIPEDRIVE_GET_ALL_RELATIONSHIPS_FOR_ORGANIZATIONAcción

Gets all of the relationships for a supplied organization id.

Parámetros de entrada

org_idintegerObligatorio
The ID of the organization to get relationships for

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all rolesPIPEDRIVE_GET_ALL_ROLESAcción

Returns all the roles within the company.

Parámetros de entrada

limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all stagesPIPEDRIVE_GET_ALL_STAGESAcción

Returns data about all stages.

Parámetros de entrada

limitinteger
Items shown per page
startinteger
Pagination start
pipeline_idinteger
The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all supported currenciesPIPEDRIVE_GET_ALL_SUPPORTED_CURRENCIESAcción

Returns all supported currencies in given account which should be used when saving monetary values with other objects. the `code` parameter of the returning objects is the currency code according to iso 4217 for all non-custom currencies.

Parámetros de entrada

termstring
Optional search term that is searched for from currency"s name and/or code

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all tasksPIPEDRIVE_GET_ALL_TASKSAcción

Returns all tasks. this is a cursor-paginated endpoint. for more information, please refer to our documentation on <a href="https://pipedrive.readme.io/docs/core-api-concepts-pagination" target=" blank" rel="noopener noreferrer">pagination</a>.

Parámetros de entrada

doneinteger
Whether the task is done or not. `0` = Not done, `1` = Done. If not omitted then returns both done and not done tasks.
limitinteger
For pagination, the limit of entries to be returned. If not provided, up to 500 items will be returned.
cursorstring
For pagination, the marker (an opaque string value) representing the first item on the next page
project_idinteger
If supplied, only tasks that are assigned to this project are returned
assignee_idinteger
If supplied, only tasks that are assigned to this user are returned
parent_task_idinteger
If `null` is supplied then only parent tasks are returned. If integer is supplied then only subtasks of a specific task are returned. By default all tasks are returned.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all teamsPIPEDRIVE_GET_ALL_TEAMSAcción

Returns data about teams within the company.

Parámetros de entrada

order_bystringenum
The field name to sort returned teams by
idnamemanager_idactive_flag
skip_usersinteger
When enabled, the teams will not include IDs of member users

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all teams of a userPIPEDRIVE_GET_ALL_TEAMS_OF_A_USERAcción

Returns data about all teams which have the specified user as a member.

Parámetros de entrada

idintegerObligatorio
The ID of the user
order_bystringenum
The field name to sort returned teams by
idnamemanager_idactive_flag
skip_usersinteger
When enabled, the teams will not include IDs of member users

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all user connectionsPIPEDRIVE_GET_ALL_USER_CONNECTIONSAcción

Returns data about all connections for the authorized user.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all usersPIPEDRIVE_GET_ALL_USERSAcción

Returns data about all users within the company.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all users in a teamPIPEDRIVE_GET_ALL_USERS_IN_A_TEAMAcción

Returns a list of all user ids within a team.

Parámetros de entrada

idintegerObligatorio
The ID of the team

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get all webhooksPIPEDRIVE_GET_ALL_WEBHOOKSAcción

Returns data about all the webhooks of a company.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a single teamPIPEDRIVE_GET_A_SINGLE_TEAMAcción

Returns data about a specific team.

Parámetros de entrada

idintegerObligatorio
The ID of the team
skip_usersinteger
When enabled, the teams will not include IDs of member users

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get current user dataPIPEDRIVE_GET_CURRENT_USER_DATAAcción

Returns data about an authorized user within the company with bound company data: company id, company name, and domain. note that the `locale` property means 'date/number format' in the pipedrive account settings, not the chosen language.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get deals conversion rates in pipelinePIPEDRIVE_GET_DEALS_CONVERSION_RATES_IN_PIPELINEAcción

Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.

Parámetros de entrada

idintegerObligatorio
The ID of the pipeline
user_idinteger
The ID of the user who"s pipeline metrics statistics to fetch. If omitted, the authorized user will be used.
end_datestringObligatorio
The end of the period. Date in format of YYYY-MM-DD.
start_datestringObligatorio
The start of the period. Date in format of YYYY-MM-DD.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get deals in a pipelinePIPEDRIVE_GET_DEALS_IN_A_PIPELINEAcción

Lists deals in a specific pipeline across all its stages.

Parámetros de entrada

idintegerObligatorio
The ID of the pipeline
limitinteger
Items shown per page
startinteger
Pagination start
user_idinteger
If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.
everyoneinteger
If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned
stage_idinteger
If supplied, only deals within the given stage will be returned
filter_idinteger
If supplied, only deals matching the given filter will be returned
get_summaryinteger
Whether to include a summary of the pipeline in the `additional_data` or not
totals_convert_currencystring
The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned inside `deals_summary` inside `additional_data` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. Only works when `get_summary` parameter flag is enabled.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get deals in a stagePIPEDRIVE_GET_DEALS_IN_A_STAGEAcción

Lists deals in a specific stage.

Parámetros de entrada

idintegerObligatorio
The ID of the stage
limitinteger
Items shown per page
startinteger
Pagination start
user_idinteger
If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.
everyoneinteger
If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned
filter_idinteger
If supplied, only deals matching the given filter will be returned

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get deals movements in pipelinePIPEDRIVE_GET_DEALS_MOVEMENTS_IN_PIPELINEAcción

Returns statistics for deals movements for the given time period.

Parámetros de entrada

idintegerObligatorio
The ID of the pipeline
user_idinteger
The ID of the user who"s pipeline statistics to fetch. If omitted, the authorized user will be used.
end_datestringObligatorio
The end of the period. Date in format of YYYY-MM-DD.
start_datestringObligatorio
The start of the period. Date in format of YYYY-MM-DD.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get deals summaryPIPEDRIVE_GET_DEALS_SUMMARYAcción

Returns a summary of all the deals.

Parámetros de entrada

statusstringenum
Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
openwonlost
user_idinteger
Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
stage_idinteger
Only deals within the given stage will be returned
filter_idinteger
<code>user_id</code> will not be considered. Only deals matching the given filter will be returned.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get deals timelinePIPEDRIVE_GET_DEALS_TIMELINEAcción

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.

Parámetros de entrada

amountintegerObligatorio
The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).
user_idinteger
If supplied, only deals matching the given user will be returned
intervalstringObligatorioenum
The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table>
dayweekmonthquarter
field_keystringObligatorio
The date field key which deals will be retrieved from
filter_idinteger
If supplied, only deals matching the given filter will be returned
start_datestringObligatorio
The date when the first interval starts. Format: YYYY-MM-DD.
pipeline_idinteger
If supplied, only deals matching the given pipeline will be returned
exclude_dealsinteger
Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.
totals_convert_currencystring
The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user"s default currency is used.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get deals where a product is attached toPIPEDRIVE_GET_DEALS_WHERE_A_PRODUCT_IS_ATTACHED_TOAcción

Returns data about deals that have a product attached to it.

Parámetros de entrada

idintegerObligatorio
The ID of the product
limitinteger
Items shown per page
startinteger
Pagination start
statusstringenum
Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.
openwonlostdeletedall_not_deleted

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get details of a boardPIPEDRIVE_GET_DETAILS_OF_A_BOARDAcción

Returns the details of a specific project board.

Parámetros de entrada

idintegerObligatorio
The ID of the project board

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get details of a call logPIPEDRIVE_GET_DETAILS_OF_A_CALL_LOGAcción

Returns details of a specific call log.

Parámetros de entrada

idstringObligatorio
The ID received when you create the call log

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get details of a dealPIPEDRIVE_GET_DETAILS_OF_A_DEALAcción

Fetches specific deal details, including exclusive fields like deal age and pipeline stage duration. custom fields show up as hashes, which can be matched using the 'key' from dealfields. see the deal details tutorial for more.

Parámetros de entrada

idintegerObligatorio
The ID of the deal

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get details of an activityPIPEDRIVE_GET_DETAILS_OF_AN_ACTIVITYAcción

Returns the details of a specific activity.

Parámetros de entrada

idintegerObligatorio
The ID of the activity

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get details of an organizationPIPEDRIVE_GET_DETAILS_OF_AN_ORGANIZATIONAcción

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 organizationfields.

Parámetros de entrada

idintegerObligatorio
The ID of the organization

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get details of a personPIPEDRIVE_GET_DETAILS_OF_A_PERSONAcción

The text describes an api endpoint that returns detailed person information, including extra fields and custom fields as hashes. it also provides `data.marketing status` if the campaigns product is used.

Parámetros de entrada

idintegerObligatorio
The ID of the person

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get details of a phasePIPEDRIVE_GET_DETAILS_OF_A_PHASEAcción

Returns the details of a specific project phase.

Parámetros de entrada

idintegerObligatorio
The ID of the project phase

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get details of a projectPIPEDRIVE_GET_DETAILS_OF_A_PROJECTAcción

Returns the details of a specific project. also note that custom fields appear as long hashes in the resulting data. these hashes can be mapped against the `key` value of project fields.

Parámetros de entrada

idintegerObligatorio
The ID of the project

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get details of a subscriptionPIPEDRIVE_GET_DETAILS_OF_A_SUBSCRIPTIONAcción

Returns details of an installment or a recurring subscription.

Parámetros de entrada

idintegerObligatorio
The ID of the subscription

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get details of a taskPIPEDRIVE_GET_DETAILS_OF_A_TASKAcción

Returns the details of a specific task.

Parámetros de entrada

idintegerObligatorio
The ID of the task

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get details of a templatePIPEDRIVE_GET_DETAILS_OF_A_TEMPLATEAcción

Returns the details of a specific project template.

Parámetros de entrada

idintegerObligatorio
The ID of the project template

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get mail threadsPIPEDRIVE_GET_MAIL_THREADSAcción

Returns mail threads in a specified folder ordered by the most recent message within.

Parámetros de entrada

limitinteger
Items shown per page
startinteger
Pagination start
folderstringObligatorioenum
The type of folder to fetch
inboxdraftssentarchive

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get one commentPIPEDRIVE_GET_ONE_COMMENTAcción

Returns the details of a comment.

Parámetros de entrada

idintegerObligatorio
The ID of the note
commentIdstringObligatorio
The ID of the comment

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get one deal fieldPIPEDRIVE_GET_ONE_DEAL_FIELDAcción

Returns data about a specific deal field.

Parámetros de entrada

idintegerObligatorio
The ID of the field

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get one filePIPEDRIVE_GET_ONE_FILEAcción

Returns data about a specific file.

Parámetros de entrada

idintegerObligatorio
The ID of the file

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get one filterPIPEDRIVE_GET_ONE_FILTERAcción

Returns data about a specific filter. note that this also returns the condition lines of the filter.

Parámetros de entrada

idintegerObligatorio
The ID of the filter

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get one leadPIPEDRIVE_GET_ONE_LEADAcción

Api returns specific lead details with custom field values in the deals format. unset custom fields are omitted. leads share custom fields with deals, not having a unique set.

Parámetros de entrada

idstringObligatorio
The ID of the lead

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get one mail messagePIPEDRIVE_GET_ONE_MAIL_MESSAGEAcción

Returns data about a specific mail message.

Parámetros de entrada

idintegerObligatorio
The ID of the mail message to fetch
include_bodyinteger
Whether to include the full message body or not. `0` = Don"t include, `1` = Include.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get one mail threadPIPEDRIVE_GET_ONE_MAIL_THREADAcción

Returns a specific mail thread.

Parámetros de entrada

idintegerObligatorio
The ID of the mail thread

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get one notePIPEDRIVE_GET_ONE_NOTEAcción

Returns details about a specific note.

Parámetros de entrada

idintegerObligatorio
The ID of the note

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get one organization fieldPIPEDRIVE_GET_ONE_ORGANIZATION_FIELDAcción

Returns data about a specific organization field.

Parámetros de entrada

idintegerObligatorio
The ID of the field

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get one organization relationshipPIPEDRIVE_GET_ONE_ORGANIZATION_RELATIONSHIPAcción

Finds and returns an organization relationship from its id.

Parámetros de entrada

idintegerObligatorio
The ID of the organization relationship
org_idinteger
The ID of the base organization for the returned calculated values

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get one permission setPIPEDRIVE_GET_ONE_PERMISSION_SETAcción

Returns data about a specific permission set.

Parámetros de entrada

idstringObligatorio
The ID of the permission set

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get one person fieldPIPEDRIVE_GET_ONE_PERSON_FIELDAcción

Returns data about a specific person field.

Parámetros de entrada

idintegerObligatorio
The ID of the field

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get one pipelinePIPEDRIVE_GET_ONE_PIPELINEAcción

Returns data about a specific pipeline. also returns the summary of the deals in this pipeline across its stages.

Parámetros de entrada

idintegerObligatorio
The ID of the pipeline
totals_convert_currencystring
The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned in `deals_summary` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get one productPIPEDRIVE_GET_ONE_PRODUCTAcción

Returns data about a specific product.

Parámetros de entrada

idintegerObligatorio
The ID of the product

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get one product fieldPIPEDRIVE_GET_ONE_PRODUCT_FIELDAcción

Returns data about a specific product field.

Parámetros de entrada

idintegerObligatorio
The ID of the product field

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get one rolePIPEDRIVE_GET_ONE_ROLEAcción

Returns the details of a specific role.

Parámetros de entrada

idintegerObligatorio
The ID of the role

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get one stagePIPEDRIVE_GET_ONE_STAGEAcción

Returns data about a specific stage.

Parámetros de entrada

idintegerObligatorio
The ID of the stage
everyoneinteger
If `everyone=1` is provided, deals summary will return deals owned by every user

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get one userPIPEDRIVE_GET_ONE_USERAcción

Returns data about a specific user within the company.

Parámetros de entrada

idintegerObligatorio
The ID of the user

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get project phasesPIPEDRIVE_GET_PROJECT_PHASESAcción

Returns all active project phases under a specific board.

Parámetros de entrada

board_idintegerObligatorio
ID of the board for which phases are requested

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get recentsPIPEDRIVE_GET_RECENTSAcción

Returns data about all recent changes occurred after the given timestamp.

Parámetros de entrada

itemsstringenum
Multiple selection of item types to include in the query (optional)
activityactivityTypedealfilefilternotepersonorganizationpipelineproductstageuser
limitinteger
Items shown per page
startinteger
Pagination start
since_timestampstringObligatorio
The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get result of a goalPIPEDRIVE_GET_RESULT_OF_A_GOALAcción

Gets the progress of a goal for the specified period.

Parámetros de entrada

idstringObligatorio
The ID of the goal that the results are looked for
period__endstringObligatorio
The end date of the period for which to find the goal"s progress. Format: YYYY-MM-DD. This date must be the same or before the goal duration end date.
period__startstringObligatorio
The start date of the period for which to find the goal"s progress. Format: YYYY-MM-DD. This date must be the same or after the goal duration start date.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Link a remote file to an itemPIPEDRIVE_LINK_A_REMOTE_FILE_TO_AN_ITEMAcción

Links an existing remote file (`googledrive`) to the item you supply. for more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-remote-file" target=" blank" rel="noopener noreferrer">adding a remote file</a>.

Parámetros de entrada

item_idintegerObligatorio
The ID of the item to associate the file with
item_typestringObligatorioenum
The item type
dealorganizationperson
remote_idstringObligatorio
The remote item ID
remote_locationstringObligatorioenum
The location type to send the file to. Only `googledrive` is supported at the moment.
googledrive

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Link User Video IntegrationPIPEDRIVE_LINK_USER_VIDEO_INTEGRATIONAcción

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.

Parámetros de entrada

user_idintegerObligatorio
Pipedrive user ID
company_idintegerObligatorio
Pipedrive company ID
user_provider_idstringObligatoriouuid
Unique identifier linking a user to the installed integration. Generated by the integration.
marketplace_client_idstringObligatorio
Pipedrive Marketplace client ID of the installed integration

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List activities associated with a dealPIPEDRIVE_LIST_ACTIVITIES_ASSOCIATED_WITH_A_DEALAcción

Lists activities associated with a deal.

Parámetros de entrada

idintegerObligatorio
The ID of the deal
doneinteger
Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both Done and Not done activities.
limitinteger
Items shown per page
startinteger
Pagination start
excludestring
A comma-separated string of activity IDs to exclude from result

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List activities associated with an organizationPIPEDRIVE_LIST_ACTIVITIES_ASSOCIATED_WITH_AN_ORGANIZATIONAcción

Lists activities associated with an organization.

Parámetros de entrada

idintegerObligatorio
The ID of the organization
doneinteger
Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.
limitinteger
Items shown per page
startinteger
Pagination start
excludestring
A comma-separated string of activity IDs to exclude from result

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List activities associated with a personPIPEDRIVE_LIST_ACTIVITIES_ASSOCIATED_WITH_A_PERSONAcción

Lists activities associated with a person.

Parámetros de entrada

idintegerObligatorio
The ID of the person
doneinteger
Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both Done and Not done activities.
limitinteger
Items shown per page
startinteger
Pagination start
excludestring
A comma-separated string of activity IDs to exclude from result

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all persons associated with a dealPIPEDRIVE_LIST_ALL_PERSONS_ASSOCIATED_WITH_A_DEALAcción

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.

Parámetros de entrada

idintegerObligatorio
The ID of the deal
limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List deals associated with an organizationPIPEDRIVE_LIST_DEALS_ASSOCIATED_WITH_AN_ORGANIZATIONAcción

Lists deals associated with an organization.

Parámetros de entrada

idintegerObligatorio
The ID of the organization
sortstring
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
limitinteger
Items shown per page
startinteger
Pagination start
statusstringenum
Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.
openwonlostdeletedall_not_deleted
only_primary_associationinteger
If set, only deals that are directly associated to the organization are fetched. If not set (default), all deals are fetched that are either directly or indirectly related to the organization. Indirect relations include relations through custom, organization-type fields and through persons of the given organization.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List deals associated with a personPIPEDRIVE_LIST_DEALS_ASSOCIATED_WITH_A_PERSONAcción

Lists deals associated with a person.

Parámetros de entrada

idintegerObligatorio
The ID of the person
sortstring
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
limitinteger
Items shown per page
startinteger
Pagination start
statusstringenum
Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.
openwonlostdeletedall_not_deleted

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List files attached to a dealPIPEDRIVE_LIST_FILES_ATTACHED_TO_A_DEALAcción

Lists files associated with a deal.

Parámetros de entrada

idintegerObligatorio
The ID of the deal
sortstring
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List files attached to an organizationPIPEDRIVE_LIST_FILES_ATTACHED_TO_AN_ORGANIZATIONAcción

Lists files associated with an organization.

Parámetros de entrada

idintegerObligatorio
The ID of the organization
sortstring
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List files attached to a personPIPEDRIVE_LIST_FILES_ATTACHED_TO_A_PERSONAcción

Lists files associated with a person.

Parámetros de entrada

idintegerObligatorio
The ID of the person
sortstring
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List files attached to a productPIPEDRIVE_LIST_FILES_ATTACHED_TO_A_PRODUCTAcción

Lists files associated with a product.

Parámetros de entrada

idintegerObligatorio
The ID of the product
sortstring
The field name and sorting mode (`field_name_1 ASC` or `field_name_1 DESC`). Supported fields: `update_time`, `id`.
limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List followers of a dealPIPEDRIVE_LIST_FOLLOWERS_OF_A_DEALAcción

Lists the followers of a deal.

Parámetros de entrada

idintegerObligatorio
The ID of the deal

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List followers of an organizationPIPEDRIVE_LIST_FOLLOWERS_OF_AN_ORGANIZATIONAcción

Lists the followers of an organization.

Parámetros de entrada

idintegerObligatorio
The ID of the organization

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List followers of a personPIPEDRIVE_LIST_FOLLOWERS_OF_A_PERSONAcción

Lists the followers of a person.

Parámetros de entrada

idintegerObligatorio
The ID of the person

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List followers of a productPIPEDRIVE_LIST_FOLLOWERS_OF_A_PRODUCTAcción

Lists the followers of a product.

Parámetros de entrada

idintegerObligatorio
The ID of the product
limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List followers of a userPIPEDRIVE_LIST_FOLLOWERS_OF_A_USERAcción

Lists the followers of a specific user.

Parámetros de entrada

idintegerObligatorio
The ID of the user

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List mail messages associated with a dealPIPEDRIVE_LIST_MAIL_MESSAGES_ASSOCIATED_WITH_A_DEALAcción

Lists mail messages associated with a deal.

Parámetros de entrada

idintegerObligatorio
The ID of the deal
limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List mail messages associated with an organizationPIPEDRIVE_LIST_MAIL_MESSAGES_ASSOCIATED_WITH_AN_ORGANIZATIONAcción

Lists mail messages associated with an organization.

Parámetros de entrada

idintegerObligatorio
The ID of the organization
limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List mail messages associated with a personPIPEDRIVE_LIST_MAIL_MESSAGES_ASSOCIATED_WITH_A_PERSONAcción

Lists mail messages associated with a person.

Parámetros de entrada

idintegerObligatorio
The ID of the person
limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List participants of a dealPIPEDRIVE_LIST_PARTICIPANTS_OF_A_DEALAcción

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 `data.marketing status` field.

Parámetros de entrada

idintegerObligatorio
The ID of the deal
limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List permission set assignmentsPIPEDRIVE_LIST_PERMISSION_SET_ASSIGNMENTSAcción

Returns the list of assignments for a permission set.

Parámetros de entrada

idstringObligatorio
The ID of the permission set
limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List permitted usersPIPEDRIVE_LIST_PERMITTED_USERSAcción

Lists the users permitted to access a deal.

Parámetros de entrada

idintegerObligatorio
The ID of the deal

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Person Access UsersPIPEDRIVE_LIST_PERSON_ACCESS_USERSAcción

List users permitted to access a person.

Parámetros de entrada

idintegerObligatorio
The ID of the person

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List persons of an organizationPIPEDRIVE_LIST_PERSONS_OF_AN_ORGANIZATIONAcción

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 `data.marketing status` field.

Parámetros de entrada

idintegerObligatorio
The ID of the organization
limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List pipeline visibility for a rolePIPEDRIVE_LIST_PIPELINE_VISIBILITY_FOR_A_ROLEAcción

Returns a list of visible or hidden pipeline ids by role. see the "visibility groups article" for details on pipeline visibility.

Parámetros de entrada

idintegerObligatorio
The ID of the role
visibleboolean
Whether to return the visible or hidden pipelines for the role

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Product Permitted UsersPIPEDRIVE_LIST_PRODUCT_PERMITTED_USERSAcción

Lists users permitted to access a product.

Parámetros de entrada

idintegerObligatorio
The ID of the product

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List products associated with a personPIPEDRIVE_LIST_PRODUCTS_ASSOCIATED_WITH_A_PERSONAcción

Lists products associated with a person.

Parámetros de entrada

idintegerObligatorio
The ID of the person
limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List products attached to a dealPIPEDRIVE_LIST_PRODUCTS_ATTACHED_TO_A_DEALAcción

Lists products attached to a deal.

Parámetros de entrada

idintegerObligatorio
The ID of the deal
limitinteger
Items shown per page
startinteger
Pagination start
include_product_datainteger
Whether to fetch product data along with each attached product (1) or not (0, default)

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List role assignmentsPIPEDRIVE_LIST_ROLE_ASSIGNMENTSAcción

Returns all users assigned to a role.

Parámetros de entrada

idintegerObligatorio
The ID of the role
limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List role settingsPIPEDRIVE_LIST_ROLE_SETTINGSAcción

Returns the visibility settings of a specific role.

Parámetros de entrada

idintegerObligatorio
The ID of the role

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List settings of an authorized userPIPEDRIVE_LIST_SETTINGS_OF_AN_AUTHORIZED_USERAcción

Lists the settings of an authorized user. example response contains a shortened list of settings.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List updates about a dealPIPEDRIVE_LIST_UPDATES_ABOUT_A_DEALAcción

Lists updates about a deal.

Parámetros de entrada

idintegerObligatorio
The ID of the deal
itemsstring
A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
limitinteger
Items shown per page
startinteger
Pagination start
all_changesstring
Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List updates about an organizationPIPEDRIVE_LIST_UPDATES_ABOUT_AN_ORGANIZATIONAcción

Lists updates about an organization.

Parámetros de entrada

idintegerObligatorio
The ID of the organization
itemsstring
A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document).
limitinteger
Items shown per page
startinteger
Pagination start
all_changesstring
Whether to show custom field updates or not. 1 = Include custom field changes. If omitted, returns changes without custom field updates.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List updates about a personPIPEDRIVE_LIST_UPDATES_ABOUT_A_PERSONAcción

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 the `marketing status` field.

Parámetros de entrada

idintegerObligatorio
The ID of the person
itemsstring
A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
limitinteger
Items shown per page
startinteger
Pagination start
all_changesstring
Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List updates about participants of a dealPIPEDRIVE_LIST_UPDATES_ABOUT_PARTICIPANTS_OF_A_DEALAcción

This endpoint provides cursor-paginated updates on deal participants. for pagination details, see the pipedrive documentation.

Parámetros de entrada

idintegerObligatorio
The ID of the deal
limitinteger
Items shown per page
cursorstring
For pagination, the marker (an opaque string value) representing the first item on the next page

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List user permissionsPIPEDRIVE_LIST_USER_PERMISSIONSAcción

Lists aggregated permissions over all assigned permission sets for a user.

Parámetros de entrada

idintegerObligatorio
The ID of the user

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List user role settingsPIPEDRIVE_LIST_USER_ROLE_SETTINGSAcción

Lists the settings of user's assigned role.

Parámetros de entrada

idintegerObligatorio
The ID of the user

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Merge two dealsPIPEDRIVE_MERGE_TWO_DEALSAcción

Merges a deal with another deal. for more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/merging-two-deals" target=" blank" rel="noopener noreferrer">merging two deals</a>.

Parámetros de entrada

idintegerObligatorio
The ID of the deal
merge_with_idintegerObligatorio
The ID of the deal that the deal will be merged with

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Merge two organizationsPIPEDRIVE_MERGE_TWO_ORGANIZATIONSAcción

Merges an organization with another organization. for more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/merging-two-organizations" target=" blank" rel="noopener noreferrer">merging two organizations</a>.

Parámetros de entrada

idintegerObligatorio
The ID of the organization
merge_with_idintegerObligatorio
The ID of the organization that the organization will be merged with

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Merge two personsPIPEDRIVE_MERGE_TWO_PERSONSAcción

Merges a person with another person. for more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/merging-two-persons" target=" blank" rel="noopener noreferrer">merging two persons</a>.

Parámetros de entrada

idintegerObligatorio
The ID of the person
merge_with_idintegerObligatorio
The ID of the person that will not be overwritten. This person’s data will be prioritized in case of conflict with the other person.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Organization accessible user listPIPEDRIVE_ORGANIZATION_ACCESSIBLE_USER_LISTAcción

List users permitted to access an organization.

Parámetros de entrada

idintegerObligatorio
The ID of the organization

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Perform a search from multiple item typesPIPEDRIVE_PERFORM_A_SEARCH_FROM_MULTIPLE_ITEM_TYPESAcción

Performs a search from your choice of item types and fields.

Parámetros de entrada

termstringObligatorio
The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
limitinteger
Items shown per page
startinteger
Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
fieldsstringenum
A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `email`, `organization_name`, `person_name`, `phone`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href="https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields" target="_blank" rel="noopener noreferrer">here</a>.<br/> When searching for leads, the email, organization_name, person_name, and phone fields will return results only for leads not linked to contacts. For searching leads by person or organization values, please use `search_for_related_items`.
addresscodecustom_fieldsemailnamenotesorganization_nameperson_namephonetitledescription
item_typesstringenum
A comma-separated string array. The type of items to perform the search from. Defaults to all.
dealpersonorganizationproductleadfilemail_attachmentproject
exact_matchboolean
When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
include_fieldsstringenum
A comma-separated string array. Supports including optional fields in the results which are not provided by default.
deal.cc_emailperson.pictureproduct.price
search_for_related_itemsboolean
When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List User Role AssignmentsPIPEDRIVE_PIPEDRIVE_LIST_USER_ROLE_ASSIGNMENTSAcción

Lists role assignments for a user.

Parámetros de entrada

idintegerObligatorio
The ID of the user
limitinteger
Items shown per page
startinteger
Pagination start

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Receives an incoming messagePIPEDRIVE_RECEIVES_AN_INCOMING_MESSAGEAcción

Adds a message to a conversation. to use the endpoint, you need to have **messengers integration** oauth scope enabled and the messaging manifest ready for the [messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).

Parámetros de entrada

idstringObligatorio
The ID of the message
statusstringObligatorioenum
The status of the message
sentdeliveredreadfailed
messagestringObligatorio
The body of the message
reply_bystringdate-time
The date and time when the message can no longer receive a reply, in UTC. Format: YYYY-MM-DD HH:MM
sender_idstringObligatorio
The ID of the provider"s user that sent the message
channel_idstringObligatorio
The channel ID as in the provider
created_atstringObligatoriodate-time
The date and time when the message was created in the provider, in UTC. Format: YYYY-MM-DD HH:MM
attachmentsobject[]
The list of attachments available in the message
conversation_idstringObligatorio
The ID of the conversation
conversation_linkstringurl
A URL that can open the conversation in the provider"s side

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Refreshing the tokensPIPEDRIVE_REFRESHING_THE_TOKENSAcción

Access tokens expire after the time specified in `expires in`. to continue accessing the api, use the `refresh token` to obtain a new access token.

Parámetros de entrada

grant_typestringenum
Since you are to refresh your access_token, you must use the value "refresh_token"
authorization_coderefresh_token
refresh_tokenstring
The refresh token that you received after you exchanged the authorization code

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Requesting authorizationPIPEDRIVE_REQUESTING_AUTHORIZATIONAcción

Authorize a user by redirecting them to the pipedrive oauth authorization page and request their permissions to act on their behalf. this step is necessary to implement only when you allow app installation outside of the marketplace.

Parámetros de entrada

statestring
You may pass any random string as the state parameter and the same string will be returned to your app after a user authorizes access. It may be used to store the user"s session ID from your app or distinguish different responses. Using state may increase security; see RFC-6749. The state parameter is not automatically available in Marketplace Manager. To enable it for your app, please write to us at marketplace.devs@pipedrive.com.
client_idstringObligatorio
The client ID provided to you by the Pipedrive Marketplace when you register your app
redirect_uristringObligatorio
The callback URL you provided when you registered your app. Authorization code will be sent to that URL (if it matches with the value you entered in the registration form) if a user approves the app install. Or, if a customer declines, the corresponding error will also be sent to this URL.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Returns project activitiesPIPEDRIVE_RETURNS_PROJECT_ACTIVITIESAcción

Returns activities linked to a specific project.

Parámetros de entrada

idintegerObligatorio
The ID of the project

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Returns project groupsPIPEDRIVE_RETURNS_PROJECT_GROUPSAcción

Returns all active groups under a specific project.

Parámetros de entrada

idintegerObligatorio
The ID of the project

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Returns project planPIPEDRIVE_RETURNS_PROJECT_PLANAcción

Returns information about items in a project plan. items consists of tasks and activities and are linked to specific project phase and group.

Parámetros de entrada

idintegerObligatorio
The ID of the project

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Returns project tasksPIPEDRIVE_RETURNS_PROJECT_TASKSAcción

Returns tasks linked to a specific project.

Parámetros de entrada

idintegerObligatorio
The ID of the project

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search dealsPIPEDRIVE_SEARCH_DEALSAcción

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.

Parámetros de entrada

termstringObligatorio
The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
limitinteger
Items shown per page
startinteger
Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
fieldsstringenum
A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href="https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields" target="_blank" rel="noopener noreferrer">here</a>.
custom_fieldsnotestitle
statusstringenum
Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
openwonlost
person_idinteger
Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
exact_matchboolean
When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
include_fieldsstringenum
Supports including optional fields in the results which are not provided by default
deal.cc_email
organization_idinteger
Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Item By FieldPIPEDRIVE_SEARCH_ITEM_BY_FIELDAcción

Performs a search from the values of a specific field. results can either be the distinct values of the field (useful for searching autocomplete field values), or the ids of actual items (deals, leads, persons, organizations or products).

Parámetros de entrada

termstringObligatorio
The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
limitinteger
Items shown per page
startinteger
Pagination start
field_keystringObligatorio
The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields" API GET methods (dealFields, personFields, etc.). Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href="https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields" target="_blank" rel="noopener noreferrer">here</a>.
field_typestringObligatorioenum
The type of the field to perform the search from
dealFieldleadFieldpersonFieldorganizationFieldproductFieldprojectField
exact_matchboolean
When enabled, only full exact matches against the given term are returned. The search <b>is</b> case sensitive.
return_item_idsboolean
Whether to return the IDs of the matching items or not. When not set or set to `0` or `false`, only distinct values of the searched field are returned. When set to `1` or `true`, the ID of each found item is returned.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search leadsPIPEDRIVE_SEARCH_LEADSAcción

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.

Parámetros de entrada

termstringObligatorio
The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
limitinteger
Items shown per page
startinteger
Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
fieldsstringenum
A comma-separated string array. The fields to perform the search from. Defaults to all of them.
custom_fieldsnotestitle
person_idinteger
Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
exact_matchboolean
When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
include_fieldsstringenum
Supports including optional fields in the results which are not provided by default
lead.was_seen
organization_idinteger
Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search organizationsPIPEDRIVE_SEARCH_ORGANIZATIONSAcción

Searches all organizations by name, address, notes and/or custom fields. this endpoint is a wrapper of <a href="https://developers.pipedrive.com/docs/api/v1/itemsearch#searchitem">/v1/itemsearch</a> with a narrower oauth scope.

Parámetros de entrada

termstringObligatorio
The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
limitinteger
Items shown per page
startinteger
Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
fieldsstringenum
A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href="https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields" target="_blank" rel="noopener noreferrer">here</a>.
addresscustom_fieldsnotesname
exact_matchboolean
When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search personsPIPEDRIVE_SEARCH_PERSONSAcción

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.

Parámetros de entrada

termstringObligatorio
The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
limitinteger
Items shown per page
startinteger
Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
fieldsstringenum
A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href="https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields" target="_blank" rel="noopener noreferrer">here</a>.
custom_fieldsemailnotesphonename
exact_matchboolean
When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
include_fieldsstringenum
Supports including optional fields in the results which are not provided by default
person.picture
organization_idinteger
Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search productsPIPEDRIVE_SEARCH_PRODUCTSAcción

Searches all products by name, code and/or custom fields. this endpoint is a wrapper of <a href="https://developers.pipedrive.com/docs/api/v1/itemsearch#searchitem">/v1/itemsearch</a> with a narrower oauth scope.

Parámetros de entrada

termstringObligatorio
The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
limitinteger
Items shown per page
startinteger
Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
fieldsstringenum
A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href="https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields" target="_blank" rel="noopener noreferrer">here</a>.
codecustom_fieldsname
exact_matchboolean
When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
include_fieldsstringenum
Supports including optional fields in the results which are not provided by default
product.price

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

UnlinkuserfromvideocallintegrationPIPEDRIVE_UNLINK_USER_FROM_VIDEO_CALL_INTEGRATIONAcción

A video calling provider must call this endpoint to remove the link between a user and the installed video calling app.

Parámetros de entrada

idstringObligatorio
Unique identifier linking a user to the installed integration

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a comment related to a notePIPEDRIVE_UPDATE_A_COMMENT_RELATED_TO_A_NOTEAcción

Updates a comment related to a note.

Parámetros de entrada

idintegerObligatorio
The ID of the note
contentstringObligatorio
The content of the comment in HTML format. Subject to sanitization on the back-end.
commentIdstringObligatorio
The ID of the comment

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update activity in project planPIPEDRIVE_UPDATE_ACTIVITY_IN_PROJECT_PLANAcción

Updates an activity phase or group in a project.

Parámetros de entrada

idintegerObligatorio
The ID of the project
group_idinteger
The ID of a group on a project board
phase_idinteger
The ID of a phase on a project board
activityIdintegerObligatorio
The ID of the activity

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a dealPIPEDRIVE_UPDATE_A_DEALAcción

Updates the properties of a deal. for more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/updating-a-deal" target=" blank" rel="noopener noreferrer">updating a deal</a>.

Parámetros de entrada

idintegerObligatorio
The ID of the deal

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a deal fieldPIPEDRIVE_UPDATE_A_DEAL_FIELDAcción

Updates a deal field. for more information, see the tutorial for <a href=" https://pipedrive.readme.io/docs/updating-custom-field-value " target=" blank" rel="noopener noreferrer">updating custom fields' values</a>.

Parámetros de entrada

idintegerObligatorio
The ID of the field
namestring
The name of the field
optionsobject[]
When `field_type` is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects. All active items must be supplied and already existing items must have their ID supplied. New items only require a label. Example: `[{"id":123,"label":"Existing Item"},{"label":"New Item"}]`
add_visible_flagboolean
Whether the field is available in "add new" modal or not (both in web and mobile app)

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a leadPIPEDRIVE_UPDATE_A_LEADAcción

Updating lead properties modifies only specified fields; use `null` to unset. custom field data matches `deals`. unset fields are omitted. leads share deals' custom fields. for examples, refer to the tutorial.

Parámetros de entrada

idstringObligatorio
The ID of the lead
titlestring
The name of the lead
owner_idinteger
The ID of the user which will be the owner of the created lead. If not provided, the user making the request will be used.
was_seenboolean
A flag indicating whether the lead was seen by someone in the Pipedrive UI
label_idsstring[]
The IDs of the lead labels which will be associated with the lead
person_idinteger
The ID of a person which this lead will be linked to. If the person does not exist yet, it needs to be created first. A lead always has to be linked to a person or organization or both.
is_archivedboolean
A flag indicating whether the lead is archived or not
value__amountinteger
Amount
organization_idinteger
The ID of an organization which this lead will be linked to. If the organization does not exist yet, it needs to be created first. A lead always has to be linked to a person or organization or both.
value__currencystring
Currency
expected_close_datestringdate
The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a lead labelPIPEDRIVE_UPDATE_A_LEAD_LABELAcción

Updates one or more properties of a lead label. only properties included in the request will be updated.

Parámetros de entrada

idstringObligatorio
The ID of the lead label
namestring
The name of the lead label
colorstringenum
The color of the label. Only a subset of colors can be used.
greenblueredyellowpurplegray

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update an activityPIPEDRIVE_UPDATE_AN_ACTIVITYAcción

Updates an activity. includes `more activities scheduled in context` property in response's `additional data` which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data).

Parámetros de entrada

idintegerObligatorio
The ID of the activity

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update an activity typePIPEDRIVE_UPDATE_AN_ACTIVITY_TYPEAcción

Updates an activity type.

Parámetros de entrada

idintegerObligatorio
The ID of the activity type
namestring
The name of the activity type
colorstring
A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black)
icon_keystringenum
Icon graphic to use for representing this activity type
taskemailmeetingdeadlinecalllunchcalendardownarrowdocumentsmartphonecamerascissors+28
order_nrinteger
An order number for this activity type. Order numbers should be used to order the types in the activity type selections.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update an installment subscriptionPIPEDRIVE_UPDATE_AN_INSTALLMENT_SUBSCRIPTIONAcción

Updates an installment subscription.

Parámetros de entrada

idintegerObligatorio
The ID of the subscription
paymentsobject[]Obligatorio
Array of payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with a explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).
update_deal_valueboolean
Indicates that the deal value must be set to installment subscription"s total value

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update an organizationPIPEDRIVE_UPDATE_AN_ORGANIZATIONAcción

Updates the properties of an organization.

Parámetros de entrada

idintegerObligatorio
The ID of the organization

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update an organization fieldPIPEDRIVE_UPDATE_AN_ORGANIZATION_FIELDAcción

Updates an organization field. for more information, see the tutorial for <a href=" https://pipedrive.readme.io/docs/updating-custom-field-value " target=" blank" rel="noopener noreferrer">updating custom fields' values</a>.

Parámetros de entrada

idintegerObligatorio
The ID of the field
namestring
The name of the field
optionsobject[]
When `field_type` is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects. All active items must be supplied and already existing items must have their ID supplied. New items only require a label. Example: `[{"id":123,"label":"Existing Item"},{"label":"New Item"}]`
add_visible_flagboolean
Whether the field is available in "add new" modal or not (both in web and mobile app)

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update an organization relationshipPIPEDRIVE_UPDATE_AN_ORGANIZATION_RELATIONSHIPAcción

Updates and returns an organization relationship.

Parámetros de entrada

idintegerObligatorio
The ID of the organization relationship
typestringenum
The type of organization relationship
parentrelated
org_idinteger
The ID of the base organization for the returned calculated values
rel_owner_org_idinteger
The owner of this relationship. If type is `parent`, then the owner is the parent and the linked organization is the daughter.
rel_linked_org_idinteger
The linked organization in this relationship. If type is `parent`, then the linked organization is the daughter.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a notePIPEDRIVE_UPDATE_A_NOTEAcción

Updates a note.

Parámetros de entrada

idintegerObligatorio
The ID of the note

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a personPIPEDRIVE_UPDATE_A_PERSONAcción

Modifies a person’s details in pipedrive. see the linked tutorial for guidance. if utilizing campaigns, the endpoint also handles `data.marketing status`.

Parámetros de entrada

idintegerObligatorio
The ID of the person

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a person fieldPIPEDRIVE_UPDATE_A_PERSON_FIELDAcción

Updates a person field. for more information, see the tutorial for <a href=" https://pipedrive.readme.io/docs/updating-custom-field-value " target=" blank" rel="noopener noreferrer">updating custom fields' values</a>.

Parámetros de entrada

idintegerObligatorio
The ID of the field
namestring
The name of the field
optionsobject[]
When `field_type` is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects. All active items must be supplied and already existing items must have their ID supplied. New items only require a label. Example: `[{"id":123,"label":"Existing Item"},{"label":"New Item"}]`
add_visible_flagboolean
Whether the field is available in "add new" modal or not (both in web and mobile app)

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a pipelinePIPEDRIVE_UPDATE_A_PIPELINEAcción

Updates the properties of a pipeline.

Parámetros de entrada

idintegerObligatorio
The ID of the pipeline
namestring
The name of the pipeline
order_nrinteger
Defines the order of pipelines. First order (`order_nr=0`) is the default pipeline.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a productPIPEDRIVE_UPDATE_A_PRODUCTAcción

Updates product data.

Parámetros de entrada

idintegerObligatorio
The ID of the product

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a product fieldPIPEDRIVE_UPDATE_A_PRODUCT_FIELDAcción

Updates a product field. for more information, see the tutorial for <a href=" https://pipedrive.readme.io/docs/updating-custom-field-value " target=" blank" rel="noopener noreferrer">updating custom fields' values</a>.

Parámetros de entrada

idintegerObligatorio
The ID of the product field
namestring
The name of the field
optionsobject[]
When `field_type` is either set or enum, possible options on update must be supplied as an array of objects each containing id and label, for example: [{"id":1, "label":"red"},{"id":2, "label":"blue"},{"id":3, "label":"lilac"}]

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a projectPIPEDRIVE_UPDATE_A_PROJECTAcción

Updates a project.

Parámetros de entrada

idintegerObligatorio
The ID of the project

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a recurring subscriptionPIPEDRIVE_UPDATE_A_RECURRING_SUBSCRIPTIONAcción

Updates a recurring subscription.

Parámetros de entrada

idintegerObligatorio
The ID of the subscription
paymentsobject[]
Array of additional payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).
descriptionstring
The description of the recurring subscription
cycle_amountinteger
The amount of each payment
effective_datestringObligatoriodate
All payments after that date will be affected. Format: YYYY-MM-DD
update_deal_valueboolean
Indicates that the deal value must be set to recurring subscription"s MRR value

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a taskPIPEDRIVE_UPDATE_A_TASKAcción

Updates a task.

Parámetros de entrada

idintegerObligatorio
The ID of the task

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a teamPIPEDRIVE_UPDATE_A_TEAMAcción

Updates an existing team and returns the updated object.

Parámetros de entrada

idintegerObligatorio
The ID of the team

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update existing goalPIPEDRIVE_UPDATE_EXISTING_GOALAcción

Updates an existing goal.

Parámetros de entrada

idstringObligatorio
The ID of the goal
titlestring
The title of the goal
intervalstringenum
The interval of the goal
weeklymonthlyquarterlyyearly

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update file detailsPIPEDRIVE_UPDATE_FILE_DETAILSAcción

Updates the properties of a file.

Parámetros de entrada

idintegerObligatorio
The ID of the file
namestring
The visible name of the file
descriptionstring
The description of the file

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update filterPIPEDRIVE_UPDATE_FILTERAcción

Updates an existing filter.

Parámetros de entrada

idintegerObligatorio
The ID of the filter
namestring
The name of the filter

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update mail thread detailsPIPEDRIVE_UPDATE_MAIL_THREAD_DETAILSAcción

Updates the properties of a mail thread.

Parámetros de entrada

idintegerObligatorio
The ID of the mail thread
deal_idinteger
The ID of the deal this thread is associated with
lead_idstringuuid
The ID of the lead this thread is associated with

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update pipeline visibility for a rolePIPEDRIVE_UPDATE_PIPELINE_VISIBILITY_FOR_A_ROLEAcción

Updates pipeline visibility settings for different roles. for details, see the pipedrive visibility groups article.

Parámetros de entrada

idintegerObligatorio
The ID of the role

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update role detailsPIPEDRIVE_UPDATE_ROLE_DETAILSAcción

Updates the parent role and/or the name of a specific role.

Parámetros de entrada

idintegerObligatorio
The ID of the role
namestring
The name of the role
parent_role_idinteger
The ID of the parent role

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update stage detailsPIPEDRIVE_UPDATE_STAGE_DETAILSAcción

Updates the properties of a stage.

Parámetros de entrada

idintegerObligatorio
The ID of the stage

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update task in project planPIPEDRIVE_UPDATE_TASK_IN_PROJECT_PLANAcción

Updates a task phase or group in a project.

Parámetros de entrada

idintegerObligatorio
The ID of the project
taskIdintegerObligatorio
The ID of the task
group_idinteger
The ID of a group on a project board
phase_idinteger
The ID of a phase on a project board

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update the product attached to a dealPIPEDRIVE_UPDATE_THE_PRODUCT_ATTACHED_TO_A_DEALAcción

Updates the details of the product that has been attached to a deal.

Parámetros de entrada

idintegerObligatorio
The ID of the deal
taxinteger
The tax percentage
commentsstring
A textual comment associated with this product-deal attachment
discountinteger
The value of the discount. The `discount_type` field can be used to specify whether the value is an amount or a percentage.
durationinteger
The duration of the product
quantityinteger
How many items of this product will be added to the deal
item_priceinteger
The price at which this product will be added to the deal
product_idinteger
The ID of the product to use
tax_methodstringenum
The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount.
exclusiveinclusivenone
enabled_flagboolean
Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default.
discount_typestringenum
The type of the discount"s value.
percentageamount
product_variation_idinteger
The ID of the product variation to use. When omitted, no variation will be used.
product_attachment_idintegerObligatorio
The ID of the deal-product (the ID of the product attached to the deal)

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update user detailsPIPEDRIVE_UPDATE_USER_DETAILSAcción

Updates the properties of a user. currently, only `active flag` can be updated.

Parámetros de entrada

idintegerObligatorio
The ID of the user
active_flagbooleanObligatorio
Whether the user is active or not. `false` = Not activated, `true` = Activated

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Triggers (3)

Los triggers son eventos externos que pueden iniciar un flujo en tus agentes (ej: nuevo email, mensaje recibido, registro creado).

New Deal Received TriggerPIPEDRIVE_NEW_DEAL_TRIGGERTrigger

Triggered when a new deal is created in Pipedrive

Configuración

Sin parámetros.

Payload del evento

currencystring
Currency of the deal
idstring
ID of the deal
stage_idstring
ID of the pipeline stage
statusstring
Status of the deal
titlestring
Title of the deal
user_idstring
ID of the user who created the deal
valuestring
Value of the deal

New Note Received TriggerPIPEDRIVE_NEW_NOTE_TRIGGERTrigger

Triggered when a new note is created in Pipedrive

Configuración

Sin parámetros.

Payload del evento

add_timestring
Time when the note was added
contentstring
Content of the note
deal_idstring
ID of the associated deal
idstring
ID of the note
org_idstring
ID of the associated organization
person_idstring
ID of the associated person
user_idstring
ID of the user who created the note

New Organization Received TriggerPIPEDRIVE_NEW_ORGANIZATION_TRIGGERTrigger

Triggered when a new organization is created in Pipedrive

Configuración

Sin parámetros.

Payload del evento

addressstring
Address of the organization
emailstring
Email of the organization
idstring
ID of the organization
namestring
Name of the organization
owner_idstring
ID of the organization owner
phonestring
Phone number of the organization
webstring
Website of the organization