TOtoggl
goals

Create a Goal

Create a Goal object with its parameters. goal_type field must contain either projects or billable object, not both, or null if the goal has workspace type.

post/goals

Request

Request body

archivedboolean
archived_atstring
cadence_periodstring
comparingstring
descriptionstring
endstring
goal_idinteger
goal_parameter_idinteger
iconinteger
icon_colorstring
namestring
startstring
target_valueinteger
type_namestring
user_idinteger
workspace_idinteger

Example request

{
  "goal_type": {
    "billable": true,
    "projects": [
      {
        "project_id": 222,
        "task_id": 333
      }
    ]
  }
}

Response

Created Goal with its ID

cadence_periodstring required
comparingstring required
descriptionstring
endstring
iconinteger
icon_colorstring
namestring required
startstring required
target_valueinteger required
workspace_idinteger required

Example response

{
  "cadence_period": "daily",
  "comparing": "greater",
  "description": "Goal long description",
  "end": "2022-05-20T00:00:00Z",
  "goal_type": {
    "billable": true,
    "projects": [
      {
        "project_id": 222,
        "task_id": 333
      }
    ]
  },
  "icon": 1,
  "icon_color": "#000000",
  "name": "Goal name",
  "start": "2021-09-20T00:00:00Z",
  "target_value": 3600,
  "workspace_id": 123
}

Changes

No recorded changes to this operation across all 1 revision of this API.