Key results

Create a key result

Changed on
post/goals/{goal_id}/key_results

Request

Path parameters

goal_idstring required

GoalId identifier

Request body

Example request

{
  "key_result": {
    "name": "Another name",
    "workflow_status": {
      "name": "On track"
    },
    "watchers": [
      689956296
    ],
    "description": "<p>new description</p>",
    "current_metric": "30%"
  }
}

Response

Successful operation

Example response

{
  "key_result": {
    "id": "6776881149483625245",
    "name": "New name",
    "reference_num": "DEMOENT-G-1-KR-1",
    "position": 3,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "progress": 0,
    "target_metric": null,
    "starting_metric": null,
    "current_metric": null,
    "description": {
      "id": "6776881149487885666",
      "body": "<p>This is the description</p>",
      "notable_id": "6776881149483625245",
      "notable_type": "KeyResult",
      "editor_version": 2,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "attachments": []
    },
    "assigned_to_user": {
      "default_assignee": false,
      "id": "689956296",
      "name": "Henry Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "workflow_status": {
      "id": "76947914",
      "name": "On Track",
      "position": 2,
      "complete": false,
      "color": "#ecdd8f",
      "workflow_status_category": {
        "id": "112353881",
        "name": "In progress"
      }
    },
    "custom_fields": []
  }
}

Changes