v1
latestOpenAPI 3.0.12026-08-0621301.7 MBAdd a new goal
Adds a new goal. Along with adding a new goal, a report is created to track the progress of your goal.
Request body
The title of the goal
Who this goal is 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.
The type of the goal. It requires the following JSON structure: { "name": "deals_started", "params": { "pipeline_id": [1, 2], "activity_type_id": [9] } }. Type can be one of: deals_won, deals_progressed, activities_completed, activities_added, deals_started or revenue_forecast. 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. The pipeline_id and activity_type_id need to be given as an array of integers. To track the goal in all pipelines, set pipeline_id as null and similarly, to track the goal for all activities, set activity_type_id as null.”
The 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.
The 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. "end" can be set to null for an infinite, open-ended goal.
The interval of the goal
Response
Successful response containing payload in the data.goal object
If the request was successful or not