X

Overview

Events

Actions

Home > Application Reference > Pipedrive

Jump to a Section

Overview

Authorizing an Account

The first time you add a Pipedrive card to a Flow, you need to set up a configuration for that Connector. Setting up a configuration will allow you to connect to your Pipedrive account, save the information, and reuse that configuration next time you build a Flow with the connector. That way, you don’t have to sign in everytime you want to build a Flow with this Connector. After you’ve set up one configuration, you can choose to use that configuration again, or set up a new one.

You can set up and save multiple configurations and share them with your teammates. Here’s how to set up a new configuration in Pipedrive:

  1. Click +Add Account
  2. Give your configuration a nickname such as “My Pipedrive Account”
  3. Find your API token:
    • Log in to your Pipedrive account
    • Click on “Settings” in the upper right hand corner
    • Under the “Personal” tab, click “API”
    • Copy the API token within the green box
  4. Paste the API token into the field and click “Next”

And your configuration is complete!

  • _CustomFields

    Custom Fields

    Custom fields that you have created in Pipedrive for any record type will be represented as a unique ID string. Follow these steps to find the text label for the custom field:

    1. Go to Settings
    2. Click “Custom Fields”
    3. Select the record type: Deal, Contact, Organization or Activity
    4. Scan for the custom field unique ID string that matches the Field API Key in Pipedrive. The Field Name can then be found to the left of the Field API Key column that matches what you see.

    You can then rename the field in the card in your Flow to match the text label:

    1. Hover over the card within your Flow on which you wish to rename a field
    2. Click the cog icon on the bottom of the card
    3. Click the pencil icon next to the field you are renaming
    4. Type in a new Display Name
    5. Click Save

    If your custom field is formatted as single option, the field will only take in certain values, each one of which is identified as a unique ID. Therefore, when writing to a custom, single option field in Pipedrive, you will need to enter in the ID of the option into that custom field, NOT the display name you see in Pipedrive.

    For example, let’s say you have a single option custom field labeled “Lead Source” on a Pipedrive contact with a Field API Key of 12309fojpiawef123dr12s3jf978 and dropdown options of “Outbound” and “Inbound”. The options “Outbound” and “Inbound” will be assigned an ID automatically through the Pipedrive API, let’s say 121 for “Outbound” and 122 for “Inbound”. When you are creating a contact in Pipedrive via a Flow that came through an inbound lead source, you would type 122 into the field 12309fojpiawef123dr12s3jf978 on the Pipedrive Create card.

    How do you know where to find the ID of the dropdown options?

    To find the ID of the single options, you need to go to Pipedrive’s API documentation. Don’t be intimidated though, you don’t need to be an engineer to follow these steps:

    1. Go to Settings.
    2. Click the Personal category and then API.
    3. Copy your personal API token.
    4. Visit this link: https://developers.pipedrive.com/v1. This is Pipedrive’s API documentation.
    5. Scroll down until you see the header “The API endpoints & live testing”. Paste your personal API token into the box labeled “Type in your API token for live testing”.
    6. Scroll down until you find the record type on which you need to find the dropdown IDs. NOTE: “Contacts” are called “Persons” in the API documentation.
    7. Click the GET button next to the “Get all xxxx fields” button. For example, if you are looking for the dropdown ID of a custom field on a Contact, click the GET button next to the box labeled “Get all person fields”.
    8. Hit “Try it!”
    9. Either scroll to find the name of the custom field you are searching for or hit control F on your keyboard to search for the field.
    10. Once you find the custom field, you’ll notice first of all that the “key” above the field name is the Field API Key that you found before. Below the “options” header, you’ll see a list of the possible options on that field. The “id” is the number you need to type into the field. The “label” is the human-readable text you see when you are in Pipedrive.

    From the Lead Source example above, you would see something like this in Pipedrive’s API documentation (important information in bold):

    “id”: 1234,
    “key”: “12309fojpiawef123dr12s3jf978”, “name”: “Lead Source”, “order_nr”: 9, “field_type”: “enum”, “add_time”: “2016-04-22 23:21:57”, “update_time”: “2016-07-05 15:25:50”, “active_flag”: true, “edit_flag”: true, “index_visible_flag”: true, “details_visible_flag”: true, “add_visible_flag”: true, “important_flag”: false, “bulk_edit_allowed”: true, “options”: [ { “id”: 121, “label”: “Outbound” }, { “id”: 122, “label”: “Inbound” …

    Again, type 122 into the field in the card in order to select Inbound as your Contact’s Lead Source.

    What about multiple option custom fields?

    If you have a custom field that can take in multiple options, follow the same steps above. Then, when entering the option ID into the field in the card, separate each value by a comma and no spaces. For example, if Lead Source was a multiple option field and you wanted to make the Contact’s Lead Source both Inbound AND Outbound, you would type 121,122 into the Lead Source field.

Events

  • New Mail Message

    Start FLO when a new mail message is sent to or received from a contact

  • New Record

    Monitors for any new records that have been added to Pipedrive since the last time the Flow triggered.

    Options

    • Your pipedrive entities (dropdown): a dropdown of your available record types to monitor in Pipedrive including deals, contacts and organizations.

    OutputFields

    Output fields are dynamically generated and will reflect the fields that are available in your Pipedrive instance for that record type. NOTE: all custom fields are represented by a unique ID string. For tips on how to work with custom fields on cards, please see the Custom Fields section below. Here are standard fields that you will see as outputs on your card:

    • id (number): the unique identifier of the new record in Pipedrive.
    • owner_id (number): the unique identifier of the owner of the new record.

    Custom Fields

    Custom fields that you have created in Pipedrive for any record type will be represented as a unique ID string. Follow these steps to find the text label for the custom field:

    1. Go to Settings
    2. Click “Custom Fields”
    3. Select the record type: Deal, Contact, Organization or Activity
    4. Scan for the custom field unique ID string that matches the Field API Key in Pipedrive. The Field Name can then be found to the left of the Field API Key column that matches what you see.

    You can then rename the field in the card in your Flow to match the text label:

    1. Hover over the card within your Flow on which you wish to rename a field
    2. Click the cog icon on the bottom of the card
    3. Click the pencil icon next to the field you are renaming
    4. Type in a new Display Name
    5. Click Save

    If your custom field is formatted as single option, the field will only take in certain values, each one of which is identified as a unique ID. Therefore, when writing to a custom, single option field in Pipedrive, you will need to enter in the ID of the option into that custom field, NOT the display name you see in Pipedrive.

    For example, let’s say you have a single option custom field labeled “Lead Source” on a Pipedrive contact with a Field API Key of 12309fojpiawef123dr12s3jf978 and dropdown options of “Outbound” and “Inbound”. The options “Outbound” and “Inbound” will be assigned an ID automatically through the Pipedrive API, let’s say 121 for “Outbound” and 122 for “Inbound”. When you are creating a contact in Pipedrive via a Flow that came through an inbound lead source, you would type 122 into the field 12309fojpiawef123dr12s3jf978 on the Pipedrive Create card.

    How do you know where to find the ID of the dropdown options?

    To find the ID of the single options, you need to go to Pipedrive’s API documentation. Don’t be intimidated though, you don’t need to be an engineer to follow these steps:

    1. Go to Settings.
    2. Click the Personal category and then API.
    3. Copy your personal API token.
    4. Visit this link: https://developers.pipedrive.com/v1. This is Pipedrive’s API documentation.
    5. Scroll down until you see the header “The API endpoints & live testing”. Paste your personal API token into the box labeled “Type in your API token for live testing”.
    6. Scroll down until you find the record type on which you need to find the dropdown IDs. NOTE: “Contacts” are called “Persons” in the API documentation.
    7. Click the GET button next to the “Get all xxxx fields” button. For example, if you are looking for the dropdown ID of a custom field on a Contact, click the GET button next to the box labeled “Get all person fields”.
    8. Hit “Try it!”
    9. Either scroll to find the name of the custom field you are searching for or hit control F on your keyboard to search for the field.
    10. Once you find the custom field, you’ll notice first of all that the “key” above the field name is the Field API Key that you found before. Below the “options” header, you’ll see a list of the possible options on that field. The “id” is the number you need to type into the field. The “label” is the human-readable text you see when you are in Pipedrive.

    From the Lead Source example above, you would see something like this in Pipedrive’s API documentation (important information in bold):

    “id”: 1234,
    “key”: “12309fojpiawef123dr12s3jf978”, “name”: “Lead Source”, “order_nr”: 9, “field_type”: “enum”, “add_time”: “2016-04-22 23:21:57”, “update_time”: “2016-07-05 15:25:50”, “active_flag”: true, “edit_flag”: true, “index_visible_flag”: true, “details_visible_flag”: true, “add_visible_flag”: true, “important_flag”: false, “bulk_edit_allowed”: true, “options”: [ { “id”: 121, “label”: “Outbound” }, { “id”: 122, “label”: “Inbound” …

    Again, type 122 into the field in the card in order to select Inbound as your Contact’s Lead Source.

    What about multiple option custom fields?

    If you have a custom field that can take in multiple options, follow the same steps above. Then, when entering the option ID into the field in the card, separate each value by a comma and no spaces. For example, if Lead Source was a multiple option field and you wanted to make the Contact’s Lead Source both Inbound AND Outbound, you would type 121,122 into the Lead Source field.

  • Updated Field in Records

    Monitors for anytime a specific field within a record is updated.

    Options

    • Your pipedrive entities (dropdown): a dropdown of your available record types to monitor in Pipedrive including deals, contacts and organizations.
    • Field Names CSV (dropdown): a dropdown of the available fields to monitor for updates.

    Output Fields

    • Id (number): the unique identifier of the updated record in Pipedrive.
    • Field Name (text): the name of the field that was updated.
    • New Value (text): the new value of the field that was updated. NOTE: If the field you are monitoring for is a multiple choice field type, this field will be written as the UI name of that choice, NOT the normal output of the Pipedrive API. For example, if you have a deal stage called Discovery and the API identifies that as 102, normally Pipedrive events and actions give you the API identity of 102. However, this monitor will output the UI name, Discovery.
    • Old Value (text): the old value of the field before it was updated. NOTE: If the field you are monitoring for is a multiple choice field type, this field will be written as the UI name of that choice, NOT the normal output of the Pipedrive API. For example, if you have a deal stage called Discovery and the API identifies that as 102, normally Pipedrive events and actions give you the API identity of 102. However, this monitor will output the UI name, Discovery.
    • Last Update (date): the time at which the field was last updated

  • Updated Record

    Monitors for any records that have been updated in Pipedrive since the last time the Flow triggered.

    Options

    • Your pipedrive entities (dropdown): a dropdown of your available record types to monitor in Pipedrive including deals, contacts and organizations.

    OutputFields

    Output fields are dynamically generated and will reflect the fields that are available in your Pipedrive instance for that record type. NOTE: all custom fields are represented by a unique ID string. For tips on how to work with custom fields on cards, please see the Custom Fields section below. Here are standard fields that you will see as outputs on your card:

    • id (number): the unique identifier of the updated record in Pipedrive.
    • owner_id (number): the unique identifier of the owner of the updated record.

    Custom Fields

    Custom fields that you have created in Pipedrive for any record type will be represented as a unique ID string. Follow these steps to find the text label for the custom field:

    1. Go to Settings
    2. Click “Custom Fields”
    3. Select the record type: Deal, Contact, Organization or Activity
    4. Scan for the custom field unique ID string that matches the Field API Key in Pipedrive. The Field Name can then be found to the left of the Field API Key column that matches what you see.

    You can then rename the field in the card in your Flow to match the text label:

    1. Hover over the card within your Flow on which you wish to rename a field
    2. Click the cog icon on the bottom of the card
    3. Click the pencil icon next to the field you are renaming
    4. Type in a new Display Name
    5. Click Save

    If your custom field is formatted as single option, the field will only take in certain values, each one of which is identified as a unique ID. Therefore, when writing to a custom, single option field in Pipedrive, you will need to enter in the ID of the option into that custom field, NOT the display name you see in Pipedrive.

    For example, let’s say you have a single option custom field labeled “Lead Source” on a Pipedrive contact with a Field API Key of 12309fojpiawef123dr12s3jf978 and dropdown options of “Outbound” and “Inbound”. The options “Outbound” and “Inbound” will be assigned an ID automatically through the Pipedrive API, let’s say 121 for “Outbound” and 122 for “Inbound”. When you are creating a contact in Pipedrive via a Flow that came through an inbound lead source, you would type 122 into the field 12309fojpiawef123dr12s3jf978 on the Pipedrive Create card.

    How do you know where to find the ID of the dropdown options?

    To find the ID of the single options, you need to go to Pipedrive’s API documentation. Don’t be intimidated though, you don’t need to be an engineer to follow these steps:

    1. Go to Settings.
    2. Click the Personal category and then API.
    3. Copy your personal API token.
    4. Visit this link: https://developers.pipedrive.com/v1. This is Pipedrive’s API documentation.
    5. Scroll down until you see the header “The API endpoints & live testing”. Paste your personal API token into the box labeled “Type in your API token for live testing”.
    6. Scroll down until you find the record type on which you need to find the dropdown IDs. NOTE: “Contacts” are called “Persons” in the API documentation.
    7. Click the GET button next to the “Get all xxxx fields” button. For example, if you are looking for the dropdown ID of a custom field on a Contact, click the GET button next to the box labeled “Get all person fields”.
    8. Hit “Try it!”
    9. Either scroll to find the name of the custom field you are searching for or hit control F on your keyboard to search for the field.
    10. Once you find the custom field, you’ll notice first of all that the “key” above the field name is the Field API Key that you found before. Below the “options” header, you’ll see a list of the possible options on that field. The “id” is the number you need to type into the field. The “label” is the human-readable text you see when you are in Pipedrive.

    From the Lead Source example above, you would see something like this in Pipedrive’s API documentation (important information in bold):

    “id”: 1234,
    “key”: “12309fojpiawef123dr12s3jf978”, “name”: “Lead Source”, “order_nr”: 9, “field_type”: “enum”, “add_time”: “2016-04-22 23:21:57”, “update_time”: “2016-07-05 15:25:50”, “active_flag”: true, “edit_flag”: true, “index_visible_flag”: true, “details_visible_flag”: true, “add_visible_flag”: true, “important_flag”: false, “bulk_edit_allowed”: true, “options”: [ { “id”: 121, “label”: “Outbound” }, { “id”: 122, “label”: “Inbound” …

    Again, type 122 into the field in the card in order to select Inbound as your Contact’s Lead Source.

    What about multiple option custom fields?

    If you have a custom field that can take in multiple options, follow the same steps above. Then, when entering the option ID into the field in the card, separate each value by a comma and no spaces. For example, if Lead Source was a multiple option field and you wanted to make the Contact’s Lead Source both Inbound AND Outbound, you would type 121,122 into the Lead Source field.

Actions

  • Create

    Creates a new activity, deal, contact or organization in Pipedrive

    Options

    • Your pipedrive entities (dropdown): a dropdown of your available record types to create in Pipedrive including activities, deals, contacts and organizations

    InputFields

    Input fields are dynamically generated and will reflect the fields that are available in your Pipedrive instance for that record type. NOTE: all custom fields are represented by a unique ID string. For tips on how to work with custom fields on cards, please see the Custom Fields section below. Here are standard fields that you will see as inputs on your card:

    • id (number): the unique identifier of the record in Pipedrive. NOTE: Do not put any data in this field. The ID will be created automatically within Pipedrive when the record is created.
    • owner_id (number): the unique identifier of the owner of the record you are creating. NOTE: This field only accepts a Pipedrive ID, not the email address or any other information about the owner of the record.

    OutputFields

    Output fields are also dynamically generated based on the record type you selected to create. The standard field that will always be returned is the ID of the record that was created.

    • id (number): the unique identifier in Pipedrive of the record that was created

    Custom Fields

    Custom fields that you have created in Pipedrive for any record type will be represented as a unique ID string. Follow these steps to find the text label for the custom field:

    1. Go to Settings
    2. Click “Custom Fields”
    3. Select the record type: Deal, Contact, Organization or Activity
    4. Scan for the custom field unique ID string that matches the Field API Key in Pipedrive. The Field Name can then be found to the left of the Field API Key column that matches what you see.

    You can then rename the field in the card in your Flow to match the text label:

    1. Hover over the card within your Flow on which you wish to rename a field
    2. Click the cog icon on the bottom of the card
    3. Click the pencil icon next to the field you are renaming
    4. Type in a new Display Name
    5. Click Save

    If your custom field is formatted as single option, the field will only take in certain values, each one of which is identified as a unique ID. Therefore, when writing to a custom, single option field in Pipedrive, you will need to enter in the ID of the option into that custom field, NOT the display name you see in Pipedrive.

    For example, let’s say you have a single option custom field labeled “Lead Source” on a Pipedrive contact with a Field API Key of 12309fojpiawef123dr12s3jf978 and dropdown options of “Outbound” and “Inbound”. The options “Outbound” and “Inbound” will be assigned an ID automatically through the Pipedrive API, let’s say 121 for “Outbound” and 122 for “Inbound”. When you are creating a contact in Pipedrive via a Flow that came through an inbound lead source, you would type 122 into the field 12309fojpiawef123dr12s3jf978 on the Pipedrive Create card.

    How do you know where to find the ID of the dropdown options?

    To find the ID of the single options, you need to go to Pipedrive’s API documentation. Don’t be intimidated though, you don’t need to be an engineer to follow these steps:

    1. Go to Settings.
    2. Click the Personal category and then API.
    3. Copy your personal API token.
    4. Visit this link: https://developers.pipedrive.com/v1. This is Pipedrive’s API documentation.
    5. Scroll down until you see the header “The API endpoints & live testing”. Paste your personal API token into the box labeled “Type in your API token for live testing”.
    6. Scroll down until you find the record type on which you need to find the dropdown IDs. NOTE: “Contacts” are called “Persons” in the API documentation.
    7. Click the GET button next to the “Get all xxxx fields” button. For example, if you are looking for the dropdown ID of a custom field on a Contact, click the GET button next to the box labeled “Get all person fields”.
    8. Hit “Try it!”
    9. Either scroll to find the name of the custom field you are searching for or hit control F on your keyboard to search for the field.
    10. Once you find the custom field, you’ll notice first of all that the “key” above the field name is the Field API Key that you found before. Below the “options” header, you’ll see a list of the possible options on that field. The “id” is the number you need to type into the field. The “label” is the human-readable text you see when you are in Pipedrive.

    From the Lead Source example above, you would see something like this in Pipedrive’s API documentation (important information in bold):

    “id”: 1234,
    “key”: “12309fojpiawef123dr12s3jf978”, “name”: “Lead Source”, “order_nr”: 9, “field_type”: “enum”, “add_time”: “2016-04-22 23:21:57”, “update_time”: “2016-07-05 15:25:50”, “active_flag”: true, “edit_flag”: true, “index_visible_flag”: true, “details_visible_flag”: true, “add_visible_flag”: true, “important_flag”: false, “bulk_edit_allowed”: true, “options”: [ { “id”: 121, “label”: “Outbound” }, { “id”: 122, “label”: “Inbound” …

    Again, type 122 into the field in the card in order to select Inbound as your Contact’s Lead Source.

    What about multiple option custom fields?

    If you have a custom field that can take in multiple options, follow the same steps above. Then, when entering the option ID into the field in the card, separate each value by a comma and no spaces. For example, if Lead Source was a multiple option field and you wanted to make the Contact’s Lead Source both Inbound AND Outbound, you would type 121,122 into the Lead Source field.

  • Delete

    Deletes a record in Pipedrive.

    Options

    • Your pipedrive entities (dropdown): a dropdown of your available record types to update in Pipedrive including activities, deals, contacts and organizations

     

    Input Field

    • id (number): the unique identifier of the record that you wish to delete in Pipedrive. NOTE: This field is required.

  • HTTP Request

    Make an authenticated HTTP request to the Pipedrive API

  • Search Record by ID

    Outputs all data on the record that is associated with the given ID.

    Options

    • Your pipedrive entities (drop down): a dropdown of your available record types to update in Pipedrive including activities, deals, contacts and organizations

    Input Fields

    • id (number): the unique identifier of the record in Pipedrive. NOTE: This field is required and must be the unique ID that Pipedrive assigns to the record upon creation. To find the ID of the record, you can use the Search by Term action in the Pipedrive connector.

    Output Fields

    Output fields are dynamically generated and will reflect the fields that are available in your Pipedrive instance for that record type. NOTE: all custom fields are represented by a unique ID string. For tips on how to work with custom fields on cards, please see the Custom Fields section below.

    Custom Fields

    Custom fields that you have created in Pipedrive for any record type will be represented as a unique ID string. Follow these steps to find the text label for the custom field:

    1. Go to Settings
    2. Click “Custom Fields”
    3. Select the record type: Deal, Contact, Organization or Activity
    4. Scan for the custom field unique ID string that matches the Field API Key in Pipedrive. The Field Name can then be found to the left of the Field API Key column that matches what you see.

    You can then rename the field in the card in your Flow to match the text label:

    1. Hover over the card within your Flow on which you wish to rename a field
    2. Click the cog icon on the bottom of the card
    3. Click the pencil icon next to the field you are renaming
    4. Type in a new Display Name
    5. Click Save

    If your custom field is formatted as single option, the field will only take in certain values, each one of which is identified as a unique ID. Therefore, when writing to a custom, single option field in Pipedrive, you will need to enter in the ID of the option into that custom field, NOT the display name you see in Pipedrive.

    For example, let’s say you have a single option custom field labeled “Lead Source” on a Pipedrive contact with a Field API Key of 12309fojpiawef123dr12s3jf978 and dropdown options of “Outbound” and “Inbound”. The options “Outbound” and “Inbound” will be assigned an ID automatically through the Pipedrive API, let’s say 121 for “Outbound” and 122 for “Inbound”. When you are creating a contact in Pipedrive via a Flow that came through an inbound lead source, you would type 122 into the field 12309fojpiawef123dr12s3jf978 on the Pipedrive Create card.

    How do you know where to find the ID of the dropdown options?

    To find the ID of the single options, you need to go to Pipedrive’s API documentation. Don’t be intimidated though, you don’t need to be an engineer to follow these steps:

    1. Go to Settings.
    2. Click the Personal category and then API.
    3. Copy your personal API token.
    4. Visit this link: https://developers.pipedrive.com/v1. This is Pipedrive’s API documentation.
    5. Scroll down until you see the header “The API endpoints & live testing”. Paste your personal API token into the box labeled “Type in your API token for live testing”.
    6. Scroll down until you find the record type on which you need to find the dropdown IDs. NOTE: “Contacts” are called “Persons” in the API documentation.
    7. Click the GET button next to the “Get all xxxx fields” button. For example, if you are looking for the dropdown ID of a custom field on a Contact, click the GET button next to the box labeled “Get all person fields”.
    8. Hit “Try it!”
    9. Either scroll to find the name of the custom field you are searching for or hit control F on your keyboard to search for the field.
    10. Once you find the custom field, you’ll notice first of all that the “key” above the field name is the Field API Key that you found before. Below the “options” header, you’ll see a list of the possible options on that field. The “id” is the number you need to type into the field. The “label” is the human-readable text you see when you are in Pipedrive.

    From the Lead Source example above, you would see something like this in Pipedrive’s API documentation (important information in bold):

    “id”: 1234,
    “key”: “12309fojpiawef123dr12s3jf978”, “name”: “Lead Source”, “order_nr”: 9, “field_type”: “enum”, “add_time”: “2016-04-22 23:21:57”, “update_time”: “2016-07-05 15:25:50”, “active_flag”: true, “edit_flag”: true, “index_visible_flag”: true, “details_visible_flag”: true, “add_visible_flag”: true, “important_flag”: false, “bulk_edit_allowed”: true, “options”: [ { “id”: 121, “label”: “Outbound” }, { “id”: 122, “label”: “Inbound” …

    Again, type 122 into the field in the card in order to select Inbound as your Contact’s Lead Source.

    What about multiple option custom fields?

    If you have a custom field that can take in multiple options, follow the same steps above. Then, when entering the option ID into the field in the card, separate each value by a comma and no spaces. For example, if Lead Source was a multiple option field and you wanted to make the Contact’s Lead Source both Inbound AND Outbound, you would type 121,122 into the Lead Source field.

  • Search Record by Term

    Search Record by Term

    Outputs all data on the first record that is found with the given term. NOTE: Not all search terms will return a result. We suggest using a search term that is unique to the record, such as email address for a contact.

    Options

    • Your pipedrive entities (dropdown): a dropdown of your available record types to update in Pipedrive including deals, contacts and organizations

      InputFields

    • term (text): the term by which you want to find a record in Pipedrive. This field is required. NOTE: Not all search terms will return a result.  For example, if you search by a date, no records will be found. We suggest using a search term that is unique to the record, such as an email address for a contact.

    OutputFields

    Output fields are dynamically generated and will reflect the fields that are available in your Pipedrive instance for the record type that was found. NOTE: all custom fields are represented by a unique ID string. For tips on how to work with custom fields on cards, please see the Custom Fields section below.

    • id (number): the unique identifier of the record that was found in Pipedrive. NOTE: ID will be returned for all records and can be used to read a record using Search by ID or to update a record using Update.

    Custom Fields

    Custom fields that you have created in Pipedrive for any record type will be represented as a unique ID string. Follow these steps to find the text label for the custom field:

    1. Go to Settings
    2. Click “Custom Fields”
    3. Select the record type: Deal, Contact, Organization or Activity
    4. Scan for the custom field unique ID string that matches the Field API Key in Pipedrive. The Field Name can then be found to the left of the Field API Key column that matches what you see.

    You can then rename the field in the card in your Flow to match the text label:

    1. Hover over the card within your Flow on which you wish to rename a field
    2. Click the cog icon on the bottom of the card
    3. Click the pencil icon next to the field you are renaming
    4. Type in a new Display Name
    5. Click Save

    If your custom field is formatted as single option, the field will only take in certain values, each one of which is identified as a unique ID. Therefore, when writing to a custom, single option field in Pipedrive, you will need to enter in the ID of the option into that custom field, NOT the display name you see in Pipedrive.

    For example, let’s say you have a single option custom field labeled “Lead Source” on a Pipedrive contact with a Field API Key of 12309fojpiawef123dr12s3jf978 and dropdown options of “Outbound” and “Inbound”. The options “Outbound” and “Inbound” will be assigned an ID automatically through the Pipedrive API, let’s say 121 for “Outbound” and 122 for “Inbound”. When you are creating a contact in Pipedrive via a Flow that came through an inbound lead source, you would type 122 into the field 12309fojpiawef123dr12s3jf978 on the Pipedrive Create card.

    How do you know where to find the ID of the dropdown options?

    To find the ID of the single options, you need to go to Pipedrive’s API documentation. Don’t be intimidated though, you don’t need to be an engineer to follow these steps:

    1. Go to Settings.
    2. Click the Personal category and then API.
    3. Copy your personal API token.
    4. Visit this link: https://developers.pipedrive.com/v1. This is Pipedrive’s API documentation.
    5. Scroll down until you see the header “The API endpoints & live testing”. Paste your personal API token into the box labeled “Type in your API token for live testing”.
    6. Scroll down until you find the record type on which you need to find the dropdown IDs. NOTE: “Contacts” are called “Persons” in the API documentation.
    7. Click the GET button next to the “Get all xxxx fields” button. For example, if you are looking for the dropdown ID of a custom field on a Contact, click the GET button next to the box labeled “Get all person fields”.
    8. Hit “Try it!”
    9. Either scroll to find the name of the custom field you are searching for or hit control F on your keyboard to search for the field.
    10. Once you find the custom field, you’ll notice first of all that the “key” above the field name is the Field API Key that you found before. Below the “options” header, you’ll see a list of the possible options on that field. The “id” is the number you need to type into the field. The “label” is the human-readable text you see when you are in Pipedrive.

    From the Lead Source example above, you would see something like this in Pipedrive’s API documentation (important information in bold):

    “id”: 1234,
    “key”: “12309fojpiawef123dr12s3jf978”, “name”: “Lead Source”, “order_nr”: 9, “field_type”: “enum”, “add_time”: “2016-04-22 23:21:57”, “update_time”: “2016-07-05 15:25:50”, “active_flag”: true, “edit_flag”: true, “index_visible_flag”: true, “details_visible_flag”: true, “add_visible_flag”: true, “important_flag”: false, “bulk_edit_allowed”: true, “options”: [ { “id”: 121, “label”: “Outbound” }, { “id”: 122, “label”: “Inbound” …

    Again, type 122 into the field in the card in order to select Inbound as your Contact’s Lead Source.

    What about multiple option custom fields?

    If you have a custom field that can take in multiple options, follow the same steps above. Then, when entering the option ID into the field in the card, separate each value by a comma and no spaces. For example, if Lead Source was a multiple option field and you wanted to make the Contact’s Lead Source both Inbound AND Outbound, you would type 121,122 into the Lead Source field.

  • Update

    Updates an existing activity, deal, contact or organization in Pipedrive.

    Options

    • Your pipedrive entities (dropdown): a dropdown of your available record types to update in Pipedrive including activities, deals, contacts and organizations

    InputFields

    Input fields are dynamically generated and will reflect the fields that are available in your Pipedrive instance for that record type. NOTE: all custom fields are represented by a unique ID string. For tips on how to work with custom fields on cards, please see the Custom Fields section below. Here are standard fields that you will see as inputs on your card:

    • id (number): the unique identifier of the record in Pipedrive. NOTE: This field is required when updating a record, and must be the unique ID that Pipedrive assigns to the record upon creation. To find the ID of the record, you can use the Search by Term action in the Pipedrive connector.
    • owner_id (number): the unique identifier of the owner of the record you are updating. NOTE: This field only accepts a Pipedrive ID, not the email address or any other information about the owner of the record.

    OutputFields

    Output fields are also dynamically generated based on the record type you selected to create and will be all the fields you see in inputs available as outputs. The standard field you will see as an output on your card is ID:

    • id (number): the unique identifier in Pipedrive of the record that was updated

    Custom Fields

    Custom fields that you have created in Pipedrive for any record type will be represented as a unique ID string. Follow these steps to find the text label for the custom field:

    1. Go to Settings
    2. Click “Custom Fields”
    3. Select the record type: Deal, Contact, Organization or Activity
    4. Scan for the custom field unique ID string that matches the Field API Key in Pipedrive. The Field Name can then be found to the left of the Field API Key column that matches what you see.

    You can then rename the field in the card in your Flow to match the text label:

    1. Hover over the card within your Flow on which you wish to rename a field
    2. Click the cog icon on the bottom of the card
    3. Click the pencil icon next to the field you are renaming
    4. Type in a new Display Name
    5. Click Save

    If your custom field is formatted as single option, the field will only take in certain values, each one of which is identified as a unique ID. Therefore, when writing to a custom, single option field in Pipedrive, you will need to enter in the ID of the option into that custom field, NOT the display name you see in Pipedrive.

    For example, let’s say you have a single option custom field labeled “Lead Source” on a Pipedrive contact with a Field API Key of 12309fojpiawef123dr12s3jf978 and dropdown options of “Outbound” and “Inbound”. The options “Outbound” and “Inbound” will be assigned an ID automatically through the Pipedrive API, let’s say 121 for “Outbound” and 122 for “Inbound”. When you are creating a contact in Pipedrive via a Flow that came through an inbound lead source, you would type 122 into the field 12309fojpiawef123dr12s3jf978 on the Pipedrive Create card.

    How do you know where to find the ID of the dropdown options?

    To find the ID of the single options, you need to go to Pipedrive’s API documentation. Don’t be intimidated though, you don’t need to be an engineer to follow these steps:

    1. Go to Settings.
    2. Click the Personal category and then API.
    3. Copy your personal API token.
    4. Visit this link: https://developers.pipedrive.com/v1. This is Pipedrive’s API documentation.
    5. Scroll down until you see the header “The API endpoints & live testing”. Paste your personal API token into the box labeled “Type in your API token for live testing”.
    6. Scroll down until you find the record type on which you need to find the dropdown IDs. NOTE: “Contacts” are called “Persons” in the API documentation.
    7. Click the GET button next to the “Get all xxxx fields” button. For example, if you are looking for the dropdown ID of a custom field on a Contact, click the GET button next to the box labeled “Get all person fields”.
    8. Hit “Try it!”
    9. Either scroll to find the name of the custom field you are searching for or hit control F on your keyboard to search for the field.
    10. Once you find the custom field, you’ll notice first of all that the “key” above the field name is the Field API Key that you found before. Below the “options” header, you’ll see a list of the possible options on that field. The “id” is the number you need to type into the field. The “label” is the human-readable text you see when you are in Pipedrive.

    From the Lead Source example above, you would see something like this in Pipedrive’s API documentation (important information in bold):

    “id”: 1234,
    “key”: “12309fojpiawef123dr12s3jf978”, “name”: “Lead Source”, “order_nr”: 9, “field_type”: “enum”, “add_time”: “2016-04-22 23:21:57”, “update_time”: “2016-07-05 15:25:50”, “active_flag”: true, “edit_flag”: true, “index_visible_flag”: true, “details_visible_flag”: true, “add_visible_flag”: true, “important_flag”: false, “bulk_edit_allowed”: true, “options”: [ { “id”: 121, “label”: “Outbound” }, { “id”: 122, “label”: “Inbound” …

    Again, type 122 into the field in the card in order to select Inbound as your Contact’s Lead Source.

    What about multiple option custom fields?

    If you have a custom field that can take in multiple options, follow the same steps above. Then, when entering the option ID into the field in the card, separate each value by a comma and no spaces. For example, if Lead Source was a multiple option field and you wanted to make the Contact’s Lead Source both Inbound AND Outbound, you would type 121,122 into the Lead Source field.