Release v22.8.0 from PR #529

CHANGELOG.md

@@ -8,6 +8,10 @@ For public Changelog covering all changes done to Pipedrive’s API, webhooks an
 
 ## [Unreleased]
 
+## [22.8.0] - 2024-05-21
+### Added
+- Added `origin`, `origin_id`, `channel` and `channel_id` parameters representing the Source for Lead and Deal entity.
+
 ## [22.7.0] - 2024-05-14
 ### Added
 - Added `billing_frequency`, `billing_frequency_cycles` and `billing_start_date` fields to
@@ -613,7 +617,8 @@ structure
 * Fixed `GET /goal/:id/results` error handling in case when there are no existing stages connected to specified goal
 * Fixed typo in lead example response (`crrency` to `currency`)
 
-[Unreleased]: https://github.com/pipedrive/api-docs/compare/v22.7.0...HEAD
+[Unreleased]: https://github.com/pipedrive/api-docs/compare/v22.8.0...HEAD
+[22.8.0]: https://github.com/pipedrive/api-docs/compare/v22.7.0...v22.8.0
 [22.7.0]: https://github.com/pipedrive/api-docs/compare/v22.6.1...v22.7.0
 [22.6.1]: https://github.com/pipedrive/api-docs/compare/v22.6.0...v22.6.1
 [22.6.0]: https://github.com/pipedrive/api-docs/compare/v22.5.0...v22.6.0

docs/AddLeadRequest.md

@@ -13,5 +13,8 @@ Name | Type | Description | Notes
 **expectedCloseDate** | **Date** | The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD. | [optional] 
 **visibleTo** | [**VisibleTo**](VisibleTo.md) | The visibility of the lead. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner & followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] 
 **wasSeen** | **Boolean** | A flag indicating whether the lead was seen by someone in the Pipedrive UI | [optional] 
+**originId** | **String** | The optional ID to further distinguish the origin of the lead - e.g. Which API integration created this lead. If omitted, `origin_id` will be set to null. | [optional] 
+**channel** | **Number** | The ID of Marketing channel this lead was created from. Provided value must be one of the channels configured for your company. You can fetch allowed values with <a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#getDealField\" target=\"_blank\" rel=\"noopener noreferrer\">GET /v1/dealFields</a>. If omitted, channel will be set to null. | [optional] 
+**channelId** | **String** | The optional ID to further distinguish the Marketing channel. If omitted, `channel_id` will be set to null. | [optional] 
 
 

docs/BaseDeal.md

@@ -56,5 +56,9 @@ Name | Type | Description | Notes
 **ccEmail** | **String** | The BCC email of the deal | [optional] 
 **orgHidden** | **Boolean** | If the organization that is associated with the deal is hidden or not | [optional] 
 **personHidden** | **Boolean** | If the person that is associated with the deal is hidden or not | [optional] 
+**origin** | **String** | The way this Deal was created. `origin` field is set by Pipedrive when Deal is created and cannot be changed. | [optional] 
+**originId** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] 
+**channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] 
+**channelId** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] 
 
 

docs/DealNonStrict.md

@@ -61,5 +61,9 @@ Name | Type | Description | Notes
 **ccEmail** | **String** | The BCC email of the deal | [optional] 
 **orgHidden** | **Boolean** | If the organization that is associated with the deal is hidden or not | [optional] 
 **personHidden** | **Boolean** | If the person that is associated with the deal is hidden or not | [optional] 
+**origin** | **String** | The way this Deal was created. `origin` field is set by Pipedrive when Deal is created and cannot be changed. | [optional] 
+**originId** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] 
+**channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] 
+**channelId** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] 
 
 

docs/DealNonStrictWithDetails.md

@@ -61,6 +61,10 @@ Name | Type | Description | Notes
 **ccEmail** | **String** | The BCC email of the deal | [optional] 
 **orgHidden** | **Boolean** | If the organization that is associated with the deal is hidden or not | [optional] 
 **personHidden** | **Boolean** | If the person that is associated with the deal is hidden or not | [optional] 
+**origin** | **String** | The way this Deal was created. `origin` field is set by Pipedrive when Deal is created and cannot be changed. | [optional] 
+**originId** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] 
+**channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] 
+**channelId** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] 
 **averageTimeToWon** | [**DealNonStrictWithDetailsAllOfAverageTimeToWon**](DealNonStrictWithDetailsAllOfAverageTimeToWon.md) |  | [optional] 
 **averageStageProgress** | **Number** | The average of the deal stage progression | [optional] 
 **age** | [**DealNonStrictWithDetailsAllOfAge**](DealNonStrictWithDetailsAllOfAge.md) |  | [optional] 

docs/DealStrict.md

@@ -61,5 +61,9 @@ Name | Type | Description | Notes
 **ccEmail** | **String** | The BCC email of the deal | [optional] 
 **orgHidden** | **Boolean** | If the organization that is associated with the deal is hidden or not | [optional] 
 **personHidden** | **Boolean** | If the person that is associated with the deal is hidden or not | [optional] 
+**origin** | **String** | The way this Deal was created. `origin` field is set by Pipedrive when Deal is created and cannot be changed. | [optional] 
+**originId** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] 
+**channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] 
+**channelId** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] 
 
 

docs/DealStrictWithMergeId.md

@@ -61,6 +61,10 @@ Name | Type | Description | Notes
 **ccEmail** | **String** | The BCC email of the deal | [optional] 
 **orgHidden** | **Boolean** | If the organization that is associated with the deal is hidden or not | [optional] 
 **personHidden** | **Boolean** | If the person that is associated with the deal is hidden or not | [optional] 
+**origin** | **String** | The way this Deal was created. `origin` field is set by Pipedrive when Deal is created and cannot be changed. | [optional] 
+**originId** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] 
+**channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] 
+**channelId** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] 
 **mergeWhatId** | **Number** | The deal ID of the deal which the original deal was merged with | [optional] 
 
 

docs/DealsApi.md

@@ -43,7 +43,7 @@ Method | HTTP request | Description
 
 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</a>.
+Adds a new deal. All deals created through the Pipedrive API will have a `origin` set to `API`. 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</a>.
 
 ### Example
 

docs/LeadResponse.md

@@ -12,6 +12,10 @@ Name | Type | Description | Notes
 **personId** | **Number** | The ID of a person which this lead is linked to | [optional] 
 **organizationId** | **Number** | The ID of an organization which this lead is linked to | [optional] 
 **sourceName** | **String** | Defines where the lead comes from. Will be `API` if the lead was created through the Public API and will be `Manually created` if the lead was created manually through the UI.  | [optional] 
+**origin** | **String** | The way this Lead was created. `origin` field is set by Pipedrive when Lead is created and cannot be changed. | [optional] 
+**originId** | **String** | The optional ID to further distinguish the origin of the lead - e.g. Which API integration created this Lead. | [optional] 
+**channel** | **Number** | The ID of your Marketing channel this Lead was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] 
+**channelId** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] 
 **isArchived** | **Boolean** | A flag indicating whether the lead is archived or not | [optional] 
 **wasSeen** | **Boolean** | A flag indicating whether the lead was seen by someone in the Pipedrive UI | [optional] 
 **value** | [**LeadValue**](LeadValue.md) |  | [optional] 

docs/LeadsApi.md

@@ -20,7 +20,7 @@ Method | HTTP request | Description
 
 Add a lead
 
-Creates a lead. A lead always has to be linked to a person or an organization or both. All leads created through the Pipedrive API will have a lead source `API` assigned. Here's the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-lead\" target=\"_blank\" rel=\"noopener noreferrer\">adding a lead</a>. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields' values tutorial</a>.
+Creates a lead. A lead always has to be linked to a person or an organization or both. All leads created through the Pipedrive API will have a lead source and origin set to `API`. Here's the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-lead\" target=\"_blank\" rel=\"noopener noreferrer\">adding a lead</a>. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields' values tutorial</a>.
 
 ### Example
 

docs/NewDeal.md

@@ -14,6 +14,9 @@ Name | Type | Description | Notes
 **pipelineId** | **Number** | The ID of the pipeline this deal will be added to. By default, the deal will be added to the first stage of the specified pipeline. Please note that `pipeline_id` and `stage_id` should not be used together as `pipeline_id` will be ignored. | [optional] 
 **stageId** | **Number** | The ID of the stage this deal will be added to. Please note that a pipeline will be assigned automatically based on the `stage_id`. If omitted, the deal will be placed in the first stage of the default pipeline. | [optional] 
 **status** | **String** | open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open. | [optional] 
+**originId** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this deal. If omitted, `origin_id` will be set to null. | [optional] 
+**channel** | **Number** | The ID of Marketing channel this deal was created from. Provided value must be one of the channels configured for your company. You can fetch allowed values with <a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#getDealField\" target=\"_blank\" rel=\"noopener noreferrer\">GET /v1/dealFields</a>. If omitted, channel will be set to null. | [optional] 
+**channelId** | **String** | The optional ID to further distinguish the Marketing channel. If omitted, `channel_id` will be set to null. | [optional] 
 **addTime** | **String** | The optional creation date & time of the deal in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] 
 **wonTime** | **String** | The optional date and time of changing the deal status as won in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Won. Can not be used together with `lost_time`. | [optional] 
 **lostTime** | **String** | The optional date and time of changing the deal status as lost in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Lost. Can not be used together with `won_time`. | [optional] 

docs/NewDealParameters.md

@@ -13,6 +13,9 @@ Name | Type | Description | Notes
 **pipelineId** | **Number** | The ID of the pipeline this deal will be added to. By default, the deal will be added to the first stage of the specified pipeline. Please note that `pipeline_id` and `stage_id` should not be used together as `pipeline_id` will be ignored. | [optional] 
 **stageId** | **Number** | The ID of the stage this deal will be added to. Please note that a pipeline will be assigned automatically based on the `stage_id`. If omitted, the deal will be placed in the first stage of the default pipeline. | [optional] 
 **status** | **String** | open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open. | [optional] 
+**originId** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this deal. If omitted, `origin_id` will be set to null. | [optional] 
+**channel** | **Number** | The ID of Marketing channel this deal was created from. Provided value must be one of the channels configured for your company. You can fetch allowed values with <a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#getDealField\" target=\"_blank\" rel=\"noopener noreferrer\">GET /v1/dealFields</a>. If omitted, channel will be set to null. | [optional] 
+**channelId** | **String** | The optional ID to further distinguish the Marketing channel. If omitted, `channel_id` will be set to null. | [optional] 
 **addTime** | **String** | The optional creation date & time of the deal in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] 
 
 

docs/UpdateDealParameters.md

@@ -13,6 +13,8 @@ Name | Type | Description | Notes
 **pipelineId** | **Number** | The ID of the pipeline this deal will be added to. By default, the deal will be added to the first stage of the specified pipeline. Please note that `pipeline_id` and `stage_id` should not be used together as `pipeline_id` will be ignored. | [optional] 
 **stageId** | **Number** | The ID of the stage this deal will be added to. Please note that a pipeline will be assigned automatically based on the `stage_id`. | [optional] 
 **status** | **String** | open = Open, won = Won, lost = Lost, deleted = Deleted. | [optional] 
+**channel** | **Number** | The ID of Marketing channel this deal was created from. Provided value must be one of the channels configured for your company which you can fetch with <a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#getDealField\" target=\"_blank\" rel=\"noopener noreferrer\">GET /v1/dealFields</a>. | [optional] 
+**channelId** | **String** | The optional ID to further distinguish the Marketing channel. | [optional]