Pipedrive (Preview)

Pipedrive (Preview)

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

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds
Frequency of trigger polls 1 120 seconds

Creating a connection

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

API Key
securestring
API Key

Actions

Add activity

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

Required Parameters

Type
string
Activity type.
Subject
string
Subject of the activity.

Optional Parameters

Due Date
string
YYYY-MM-DD
Due Time
string
HH:MM
Duration
string
HH:MM
Notes
string
Assigned to
integer
Id of the user whom the activity will be assigned to.
Deal Id
integer
ID of deal the activity will be associated with.
Contact Id
integer
Id of person the activity will be associated with.
Organization Id
integer
ID of the organization the activity will be associated with.

Returns

Body
ActivityResponse

data

Add deal

This operation creates a new deal for the authorized account.

Required Parameters

Title
string
Title of the deal.

Optional Parameters

Stage Id
string
Stage of the deal.
Status
string
Status of the deal.
Value
integer
Monetary value of the deal.
Currency
string
Currency of the deal.
Contact Id
string
User id of person the deal is associated with.
Organization Id
string
Id of the organization associated with the deal.
Expected Close Date
string
yyyy-MM-dd
Visiblity
string
Owner, followers or entire company.

Returns

Body
DealResponse

data

Get deal by id

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

Required Parameters

Deal Id
integer
Deal

Returns

Body
DealResponse

data

Update deal stage

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

Required Parameters

Deal Id
integer
Deal
Stage Id
string
Stage of the deal.

Optional Parameters

Expected Close Date
string
yyyy-MM-dd

Returns

Body
DealResponse

data

Update deal status

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

Required Parameters

Deal Id
integer
Deal
Status
string
Status of the deal.

Optional Parameters

Lost Reason
string
Message about why the deal was lost.

Returns

Body
DealResponse

data

Triggers

When a new activity is added

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

Returns

Body
ActivityResponse

data

When a new deal is added

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

Returns

Body
DealResponse

data

Definitions

ActivityResponse

data

Activity Id
integer
Unique id of the activity.
Assigned to
integer
User id of user whom the activity is assigned to.
Completed Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Contact Id
integer
Id of person the activity is associated with.
Contact Name
string
Name of person the activity is associated with.
Created Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Created by
integer
User id of user that created the activity.
Deal Id
integer
Id of deal the activity is associated with.
Deal Title
string
Title of deal the activity is associated with.
Due Date
string
YYYY-MM-DD
Due Time
string
HH:MM
Duration
string
HH:MM
Google Calendar Event Id
string
Id of the google calendar event.
Google Calendar Id
string
Id of the google calendar.
Is Done
boolean
0 = Not done, 1 = Done
Note
string
Note of the activity (HTML format).
Organization Id
integer
Id of organization the activity is associated with.
Organization Name
string
Name of organization the activity is associated with.
Owner Name
string
Name of the activity owner.
Subject
string
Subject of the activity.
Type
string
Type of the activity.
Updates Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
User Id
integer
Id of the user whom the activity is assigned to.

DealResponse

data

Activities Count
integer
Number of activities associated with the deal.
Closed Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Created Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Currency
string
Currency associated with the deal value.
Deal Id
integer
Id of the deal.
Deal Title
string
Title of the deal.
Deal Value
integer
Monetary value of the deal.
Done Activities Count
integer
Number of done activities associated with the deal.
Email
string
Email of the deal creator.
Email
string
Email of the deal owner.
Email Message Count
integer
Number of email messages associated with the deal.
Expected Close Date
string
yyyy-MM-dd
Files Count
integer
Number of files associated with the deal.
Followers Count
integer
Number of followers associated with the deal.
Id
integer
Id of the person associated with the deal.
Id
integer
Id of the deal creator.
Id
integer
Id of the organization associated with the deal.
Id
integer
Id of the deal owner.
Is Active
boolean
True if the deal is active.
Is Deleted
boolean
True if the deal has been deleted.
Last Activity Date
string
yyyy-MM-dd
Last Activity Id
string
Id of the last activity.
Lost Reason
string
Message about why the deal was lost (to be used when status=lost).
Name
string
Name of the deal owner.
Name
string
Name of the organization associated with the deal.
Name
string
Name of the deal creator.
Name
string
Name of the person associated with the deal.
Next Activity Date
string
yyyy-MM-dd
Next Activity Duration
string
Duration of next activity associated with the deal.
Next Activity Id
integer
Id of the next activity.
Next Activity Note
string
Notes for next activity associated with the deal
Next Activity Subject
string
Subject of next activity associated with the deal.
Next Activity Time
string
yyyy-MM-ddTHH:mm:ss.fffZ
Next Activity Type
string
Type of next activity associated with the deal.
Notes Count
integer
Number of notes associated with the deal.
Participants Count
integer
Number of participants associated with the deal.
Pipeline Id
integer
Id of pipeline the deal is associated with.
Products Count
integer
Number of products associated with the deal.
Referenced Activities Count
integer
Number of referenced activities associated with the deal.
Stage Id
integer
ID of stage the deal is placed in a pipeline.
Stage Name
string
Name of stage the deal is placed in a pipeline
Stage Uodated Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Status
string
Open, won, lost or deleted.
Undone Activities Count
integer
Number of undone activitie associated with the deals.
Updated Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Visiblity
string
Owner, followers or entire company.