Skip to content

Latest commit

 

History

History
29 lines (15 loc) · 2.39 KB

NewGoal.md

File metadata and controls

29 lines (15 loc) · 2.39 KB

Pipedrive.NewGoal

Properties

Name Type Description Notes
title String Title of the goal. [optional]
assignee Object Who is this goal assigned to. It requires the following JSON structure: { "id": "1", "type": "person" }. `type` can be either `person`, `company` or `team`. ID of the assignee person, company or team. [optional]
type Object Type of the goal. It requires the following JSON structure: { "name": "deals_started", "params": { "pipeline_id": 1 } }. Type can be one of: `deals_won`,`deals_progressed`,`activities_completed`,`activities_added` or `deals_started`. `params` can include `pipeline_id`, `stage_id` or `activity_type_id`. `stage_id` is related to only `deals_progressed` type of goals and `activity_type_id` to `activities_completed` or `activities_added` types of goals. To track goal in all pipelines set `pipeline_id` as `null`. [optional]
expectedOutcome Object Expected outcome of the goal. Expected outcome can be tracked either by `quantity` or by `sum`. It requires the following JSON structure: { "target": "50", "tracking_metric": "quantity" } or { "target": "50", "tracking_metric": "sum", "currency_id": 1 }. `currency_id` should only be added to `sum` type of goals. [optional]
duration Object Date when the goal starts and ends. It requires the following JSON structure: { "start": "2019-01-01", "end": "2022-12-31" }. Date in format of YYYY-MM-DD. [optional]
interval String Date when the goal starts and ends. It requires the following JSON structure: { "start": "2019-01-01", "end": "2022-12-31" }. Date in format of YYYY-MM-DD. [optional]

Enum: IntervalEnum

  • weekly (value: "weekly")

  • monthly (value: "monthly")

  • quarterly (value: "quarterly")

  • yearly (value: "yearly")