Pipedrive (Preview)

Pipedrive is a CRM & pipeline management tool that helps you focus on actions that matter.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Flow Premium All Flow regions except the following:
     -   US Government (GCC)
PowerApps Premium All PowerApps regions except the following:
     -   US Government (GCC)

Creating a connection

To connect your account, you will need the following information:

Name Type Description
API Key securestring

API Key

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds
Frequency of trigger polls1120 seconds

Actions

Add activity

This operation is used to create a new activity for the authorized account.

Add deal

This operation creates a new deal for the authorized account.

Get deal by id

This operation retrieves all details of an existing deal, given its id.

Update deal stage

This operation is used to update the stage associated with a deal, given its id.

Update deal status

This operation is used to update the status associated with a deal, given its id.

Add activity

This operation is used to create a new activity for the authorized account.

Parameters

Name Key Required Type Description
Type
type True string

Activity type.

Subject
subject True string

Subject of the activity.

Due Date
due_date string

YYYY-MM-DD

Due Time
due_time string

HH:MM

Duration
duration string

HH:MM

Notes
note string

Activity type.

Assigned to
user_id integer

Id of the user whom the activity will be assigned to.

Deal Id
deal_id integer

ID of deal the activity will be associated with.

Contact Id
person_id integer

Id of person the activity will be associated with.

Organization Id
org_id integer

ID of the organization the activity will be associated with.

Returns

data

Add deal

This operation creates a new deal for the authorized account.

Parameters

Name Key Required Type Description
Title
title True string

Title of the deal.

Stage Id
stage_id string

Stage of the deal.

Status
status string

Status of the deal.

Value
value integer

Monetary value of the deal.

Currency
currency string

Currency of the deal.

Contact Id
person_id string

User id of person the deal is associated with.

Organization Id
org_id string

Id of the organization associated with the deal.

Expected Close Date
expected_close_date string

yyyy-MM-dd

Visiblity
visible_to string

Owner, followers or entire company.

Returns

data

Get deal by id

This operation retrieves all details of an existing deal, given its id.

Parameters

Name Key Required Type Description
Deal Id
dealId True integer

Deal

Returns

data

Update deal stage

This operation is used to update the stage associated with a deal, given its id.

Parameters

Name Key Required Type Description
Deal Id
dealId True integer

Deal

Stage Id
stage_id True string

Stage of the deal.

Expected Close Date
expected_close_date string

yyyy-MM-dd

Returns

data

Update deal status

This operation is used to update the status associated with a deal, given its id.

Parameters

Name Key Required Type Description
Deal Id
dealId True integer

Deal

Status
status True string

Status of the deal.

Lost Reason
lost_reason string

Message about why the deal was lost.

Returns

data

Triggers

When a new activity is added

Triggers when a new activity is added to the authorized account.

When a new deal is added

Triggers when a new deal is added to the authorized account.

When a new activity is added

Triggers when a new activity is added to the authorized account.

Returns

data

When a new deal is added

Triggers when a new deal is added to the authorized account.

Returns

data

Definitions

ActivityResponse

data

Name Path Type Description
Activity Id
id integer

Unique id of the activity.

User Id
user_id integer

Id of the user whom the activity is assigned to.

Is Done
done boolean

0 = Not done, 1 = Done

Type
type string

Type of the activity.

Due Date
due_date string

YYYY-MM-DD

Due Time
due_time string

HH:MM

Duration
duration string

HH:MM

Subject
subject string

Subject of the activity.

Deal Id
deal_id integer

Id of deal the activity is associated with.

Deal Title
deal_title string

Title of deal the activity is associated with.

Organization Id
org_id integer

Id of organization the activity is associated with.

Organization Name
org_name string

Name of organization the activity is associated with.

Contact Id
person_id integer

Id of person the activity is associated with.

Contact Name
person_name string

Name of person the activity is associated with.

Created Date-Time
add_time date-time

yyyy-MM-ddTHH:mm:ss.fffZ

Updates Date-Time
update_time date-time

yyyy-MM-ddTHH:mm:ss.fffZ

Completed Date-Time
marked_as_done_time date-time

yyyy-MM-ddTHH:mm:ss.fffZ

Google Calendar Event Id
gcal_event_id string

Id of the google calendar event.

Google Calendar Id
google_calendar_id string

Id of the google calendar.

Note
note string

Note of the activity (HTML format).

Assigned to
assigned_to_user_id integer

User id of user whom the activity is assigned to.

Created by
created_by_user_id integer

User id of user that created the activity.

Owner Name
owner_name string

Name of the activity owner.

DealResponse

data

Name Path Type Description
Deal Id
id integer

Id of the deal.

Id
creator_user_id.id integer

Id of the deal creator.

Name
creator_user_id.name string

Name of the deal creator.

Email
creator_user_id.email string

Email of the deal creator.

Id
user_id.id integer

Id of the deal owner.

Name
user_id.name string

Name of the deal owner.

Email
user_id.email string

Email of the deal owner.

Name
person_id.name string

Name of the person associated with the deal.

Id
person_id.value integer

Id of the person associated with the deal.

Name
org_id.name string

Name of the organization associated with the deal.

Id
org_id.value integer

Id of the organization associated with the deal.

Status
status string

Open, won, lost or deleted.

Deal Title
title string

Title of the deal.

Deal Value
value number

Monetary value of the deal.

Currency
currency string

Currency associated with the deal value.

Created Date-Time
add_time date-time

yyyy-MM-ddTHH:mm:ss.fffZ

Updated Date-Time
update_time date-time

yyyy-MM-ddTHH:mm:ss.fffZ

Stage Id
stage_id integer

ID of stage the deal is placed in a pipeline.

Stage Name
stage_name string

Name of stage the deal is placed in a pipeline

Stage Uodated Date-Time
stage_change_time date-time

yyyy-MM-ddTHH:mm:ss.fffZ

Is Active
active boolean

True if the deal is active.

Is Deleted
deleted boolean

True if the deal has been deleted.

Next Activity Date
next_activity_date string

yyyy-MM-dd

Next Activity Time
next_activity_time string

yyyy-MM-ddTHH:mm:ss.fffZ

Next Activity Id
next_activity_id integer

Id of the next activity.

Last Activity Id
last_activity_id integer

Id of the last activity.

Last Activity Date
last_activity_date string

yyyy-MM-dd

Lost Reason
lost_reason string

Message about why the deal was lost (to be used when status=lost).

Visiblity
visible_to string

Owner, followers or entire company.

Closed Date-Time
close_time date-time

yyyy-MM-ddTHH:mm:ss.fffZ

Pipeline Id
pipeline_id integer

Id of pipeline the deal is associated with.

Products Count
products_count integer

Number of products associated with the deal.

Files Count
files_count integer

Number of files associated with the deal.

Notes Count
notes_count integer

Number of notes associated with the deal.

Followers Count
followers_count integer

Number of followers associated with the deal.

Email Message Count
email_messages_count integer

Number of email messages associated with the deal.

Activities Count
activities_count integer

Number of activities associated with the deal.

Done Activities Count
done_activities_count integer

Number of done activities associated with the deal.

Undone Activities Count
undone_activities_count integer

Number of undone activitie associated with the deals.

Referenced Activities Count
reference_activities_count integer

Number of referenced activities associated with the deal.

Participants Count
participants_count integer

Number of participants associated with the deal.

Expected Close Date
expected_close_date string

yyyy-MM-dd

Next Activity Subject
next_activity_subject string

Subject of next activity associated with the deal.

Next Activity Type
next_activity_type string

Type of next activity associated with the deal.

Next Activity Duration
next_activity_duration string

Duration of next activity associated with the deal.

Next Activity Note
next_activity_note string

Notes for next activity associated with the deal