Pipedrive\DealsApi

All URIs are relative to https://api.pipedrive.com/v1.

Method	HTTP request	Description
addDeal()	POST /deals	Add a deal
addDealFollower()	POST /deals/{id}/followers	Add a follower to a deal
addDealParticipant()	POST /deals/{id}/participants	Add a participant to a deal
addDealProduct()	POST /deals/{id}/products	Add a product to a deal
deleteDeal()	DELETE /deals/{id}	Delete a deal
deleteDealFollower()	DELETE /deals/{id}/followers/{follower_id}	Delete a follower from a deal
deleteDealParticipant()	DELETE /deals/{id}/participants/{deal_participant_id}	Delete a participant from a deal
deleteDealProduct()	DELETE /deals/{id}/products/{product_attachment_id}	Delete an attached product from a deal
deleteDeals()	DELETE /deals	Delete multiple deals in bulk
duplicateDeal()	POST /deals/{id}/duplicate	Duplicate deal
getDeal()	GET /deals/{id}	Get details of a deal
getDealActivities()	GET /deals/{id}/activities	List activities associated with a deal
getDealFiles()	GET /deals/{id}/files	List files attached to a deal
getDealFollowers()	GET /deals/{id}/followers	List followers of a deal
getDealMailMessages()	GET /deals/{id}/mailMessages	List mail messages associated with a deal
getDealParticipants()	GET /deals/{id}/participants	List participants of a deal
getDealParticipantsChangelog()	GET /deals/{id}/participantsChangelog	List updates about participants of a deal
getDealPersons()	GET /deals/{id}/persons	List all persons associated with a deal
getDealProducts()	GET /deals/{id}/products	List products attached to a deal
getDealUpdates()	GET /deals/{id}/flow	List updates about a deal
getDealUsers()	GET /deals/{id}/permittedUsers	List permitted users
getDeals()	GET /deals	Get all deals
getDealsCollection()	GET /deals/collection	Get all deals (BETA)
getDealsSummary()	GET /deals/summary	Get deals summary
getDealsTimeline()	GET /deals/timeline	Get deals timeline
mergeDeals()	PUT /deals/{id}/merge	Merge two deals
searchDeals()	GET /deals/search	Search deals
updateDeal()	PUT /deals/{id}	Update a deal
updateDealProduct()	PUT /deals/{id}/products/{product_attachment_id}	Update the product attached to a deal

`addDeal()`

addDeal($new_deal): \Pipedrive\Model\GetAddedDeal

Add a deal

Adds a new deal. 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. To determine which custom fields exists, fetch the dealFields and look for key values. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/creating-a-deal\" target="_blank" rel="noopener noreferrer">adding a deal.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key
$config = (new Pipedrive\Configuration())->setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\Configuration())->setApiKeyPrefix('api_token', 'Bearer');

// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Pipedrive\Api\DealsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$new_deal = new \Pipedrive\Model\NewDeal(); // \Pipedrive\Model\NewDeal

try {
    $result = $apiInstance->addDeal($new_deal);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DealsApi->addDeal: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
new_deal	\Pipedrive\Model\NewDeal		[optional]

Name	Type	Description	Notes
id	int	The ID of the deal
add_deal_follower_request	\Pipedrive\Model\AddDealFollowerRequest		[optional]

Name	Type	Description	Notes
id	int	The ID of the deal
add_deal_participant_request	\Pipedrive\Model\AddDealParticipantRequest		[optional]

Name	Type	Description	Notes
id	int	The ID of the deal
new_deal_product	\Pipedrive\Model\NewDealProduct		[optional]

Name	Type	Description	Notes
id	int	The ID of the deal
follower_id	int	The ID of the follower

Name	Type	Description	Notes
id	int	The ID of the deal
deal_participant_id	int	The ID of the participant of the deal

Name	Type	Description	Notes
id	int	The ID of the deal
product_attachment_id	int	The product attachment ID

Name	Type	Description	Notes
id	int	The ID of the deal
start	int	Pagination start	[optional] [default to 0]
limit	int	Items shown per page	[optional]
done	\Pipedrive\Model\NumberBoolean	Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both Done and Not done activities.	[optional]
exclude	string	A comma-separated string of activity IDs to exclude from result	[optional]

Name	Type	Description	Notes
user_id	int	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.	[optional]
filter_id	int	The ID of the filter to use	[optional]
stage_id	int	If supplied, only deals within the given stage will be returned	[optional]
status	string	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.	[optional] [default to 'all_not_deleted']
start	int	Pagination start	[optional] [default to 0]
limit	int	Items shown per page	[optional]
sort	string	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).	[optional]
owned_by_you	\Pipedrive\Model\NumberBoolean	When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied.	[optional]

Name	Type	Description	Notes
cursor	string	For pagination, the marker (an opaque string value) representing the first item on the next page	[optional]
limit	int	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.	[optional]
since	string	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.	[optional]
until	string	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.	[optional]
user_id	int	If supplied, only deals matching the given user will be returned	[optional]
stage_id	int	If supplied, only deals within the given stage will be returned	[optional]
status	string	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.	[optional]

Name	Type	Description	Notes
start_date	\DateTime	The date when the first interval starts. Format: YYYY-MM-DD.
interval	string	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>
amount	int	The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).
field_key	string	The date field key which deals will be retrieved from
user_id	int	If supplied, only deals matching the given user will be returned	[optional]
pipeline_id	int	If supplied, only deals matching the given pipeline will be returned	[optional]
filter_id	int	If supplied, only deals matching the given filter will be returned	[optional]
exclude_deals	\Pipedrive\Model\NumberBoolean	Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.	[optional]
totals_convert_currency	string	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.	[optional]

Name	Type	Description	Notes
id	int	The ID of the deal
merge_deals_request	\Pipedrive\Model\MergeDealsRequest		[optional]

Name	Type	Description	Notes
term	string	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.
fields	string	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>.	[optional]
exact_match	bool	When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.	[optional]
person_id	int	Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.	[optional]
organization_id	int	Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.	[optional]
status	string	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.	[optional]
include_fields	string	Supports including optional fields in the results which are not provided by default	[optional]
start	int	Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.	[optional] [default to 0]
limit	int	Items shown per page	[optional]

Name	Type	Description	Notes
id	int	The ID of the deal
update_deal_request	\Pipedrive\Model\UpdateDealRequest		[optional]

Files

DealsApi.md

Latest commit

History

DealsApi.md

File metadata and controls

Pipedrive\DealsApi

addDeal()

Example

Parameters

Return type

Authorization

HTTP request headers

addDealFollower()

Example

Parameters

Return type

Authorization

HTTP request headers

addDealParticipant()

Example

Parameters

Return type

Authorization

HTTP request headers

addDealProduct()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteDeal()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteDealFollower()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteDealParticipant()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteDealProduct()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteDeals()

Example

Parameters

Return type

Authorization

HTTP request headers

duplicateDeal()

Example

Parameters

Return type

Authorization

HTTP request headers

getDeal()

Example

Parameters

Return type

Authorization

HTTP request headers

getDealActivities()

Example

Parameters

Return type

Authorization

HTTP request headers

getDealFiles()

`addDeal()`

`addDealFollower()`

`addDealParticipant()`

`addDealProduct()`

`deleteDeal()`

`deleteDealFollower()`

`deleteDealParticipant()`

`deleteDealProduct()`

`deleteDeals()`

`duplicateDeal()`

`getDeal()`

`getDealActivities()`

`getDealFiles()`

`getDealFollowers()`

`getDealMailMessages()`

`getDealParticipants()`

`getDealParticipantsChangelog()`

`getDealPersons()`

`getDealProducts()`

`getDealUpdates()`

`getDealUsers()`

`getDeals()`

`getDealsCollection()`