Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]
### Fixed
- Fixed `GET /v1/deals/{id}/participants` and `POST /v1/deals/{id}/participants` response schemas to accurately represent the API response structure. Added `DealParticipantItem` schema with proper nesting of `email` and `phone` fields within `person_id` object, replacing incorrect `PersonItem` reference.

## [15.3.0](https://github.com/pipedrive/client-php/compare/15.2.0...15.3.0) (2026-02-06)

Expand Down
17 changes: 17 additions & 0 deletions docs/versions/v1/Model/DealParticipantItem.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# # DealParticipantItem

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | The ID of the participant | [optional]
**person_id** | [**\Pipedrive\versions\v1\Model\DealParticipantItemPersonId**](DealParticipantItemPersonId.md) | | [optional]
**add_time** | **string** | The date and time when the participant was added. Format: YYYY-MM-DD HH:MM:SS | [optional]
**active_flag** | **bool** | Whether the participant is active or not | [optional]
**related_item_data** | [**\Pipedrive\versions\v1\Model\DealParticipantItemRelatedItemData**](DealParticipantItemRelatedItemData.md) | | [optional]
**person** | [**\Pipedrive\versions\v1\Model\PersonItem**](PersonItem.md) | | [optional]
**added_by_user_id** | [**\Pipedrive\versions\v1\Model\User**](User.md) | | [optional]
**related_item_type** | **string** | The type of the related item | [optional]
**related_item_id** | **int** | The ID of the related item | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 changes: 15 additions & 0 deletions docs/versions/v1/Model/DealParticipantItemPersonId.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# # DealParticipantItemPersonId

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**active_flag** | **bool** | Whether the person is active or not | [optional]
**name** | **string** | The name of the person | [optional]
**email** | [**\Pipedrive\versions\v1\Model\DealParticipantItemPersonIdEmail[]**](DealParticipantItemPersonIdEmail.md) | An email address as a string or an array of email objects related to the person. The structure of the array is as follows: `[{ \"value\": \"mail@example.com\", \"primary\": \"true\", \"label\": \"main\" }]`. Please note that only `value` is required. | [optional]
**phone** | [**\Pipedrive\versions\v1\Model\BasePersonItemPhone[]**](BasePersonItemPhone.md) | A phone number supplied as a string or an array of phone objects related to the person. The structure of the array is as follows: `[{ \"value\": \"12345\", \"primary\": \"true\", \"label\": \"mobile\" }]`. Please note that only `value` is required. | [optional]
**owner_id** | **int** | The ID of the owner of the person | [optional]
**company_id** | **int** | The ID of the company related to the person | [optional]
**value** | **int** | The ID of the person | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 changes: 11 additions & 0 deletions docs/versions/v1/Model/DealParticipantItemPersonIdEmail.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# # DealParticipantItemPersonIdEmail

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **string** | The email address | [optional]
**primary** | **bool** | Boolean that indicates if email is primary for the person or not | [optional]
**label** | **string** | The label that indicates the type of the email. (Possible values - work, home or other) | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 changes: 10 additions & 0 deletions docs/versions/v1/Model/DealParticipantItemRelatedItemData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# # DealParticipantItemRelatedItemData

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**deal_id** | **int** | The ID of the deal | [optional]
**title** | **string** | The title of the deal | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
2 changes: 1 addition & 1 deletion docs/versions/v1/Model/DealParticipants.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**success** | **bool** | If the request was successful or not | [optional]
**data** | [**\Pipedrive\versions\v1\Model\PersonItem[]**](PersonItem.md) | The array of participants | [optional]
**data** | [**\Pipedrive\versions\v1\Model\DealParticipantItem[]**](DealParticipantItem.md) | The array of participants | [optional]
**additional_data** | [**\Pipedrive\versions\v1\Model\AdditionalData**](AdditionalData.md) | | [optional]
**related_objects** | [**\Pipedrive\versions\v1\Model\GetDealsRelatedObjects**](GetDealsRelatedObjects.md) | | [optional]

Expand Down
2 changes: 1 addition & 1 deletion docs/versions/v1/Model/PostDealParticipants.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**success** | **bool** | If the request was successful or not | [optional]
**data** | [**PersonItem**](PersonItem.md) | The object of participant | [optional]
**data** | [**\Pipedrive\versions\v1\Model\DealParticipantItem**](DealParticipantItem.md) | | [optional]
**related_objects** | [**\Pipedrive\versions\v1\Model\PostDealParticipantsRelatedObjects**](PostDealParticipantsRelatedObjects.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
7 changes: 4 additions & 3 deletions docs/versions/v1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -711,6 +711,10 @@ Class | Method | HTTP request | Description
- [DealOrganizationDataWithId](Model/DealOrganizationDataWithId.md)
- [DealOrganizationDataWithIdAllOf](Model/DealOrganizationDataWithIdAllOf.md)
- [DealParticipantCountInfo](Model/DealParticipantCountInfo.md)
- [DealParticipantItem](Model/DealParticipantItem.md)
- [DealParticipantItemPersonId](Model/DealParticipantItemPersonId.md)
- [DealParticipantItemPersonIdEmail](Model/DealParticipantItemPersonIdEmail.md)
- [DealParticipantItemRelatedItemData](Model/DealParticipantItemRelatedItemData.md)
- [DealParticipants](Model/DealParticipants.md)
- [DealParticipantsChangelog](Model/DealParticipantsChangelog.md)
- [DealPersonData](Model/DealPersonData.md)
Expand Down Expand Up @@ -1370,7 +1374,4 @@ Class | Method | HTTP request | Description
- **goals:full**: Create, read, update and delete goals
- **video-calls**: Allows application to register as a video call integration provider and create conference links
- **messengers-integration**: Allows application to register as a messengers integration provider and allows them to deliver incoming messages and their statuses
- **deal-fields:full**: Create, read, update and delete deal fields
- **product-fields:full**: Create, read, update and delete product fields
- **contact-fields:full**: Create, read, update and delete person and organization fields

Loading