Update Objective | Taktoria API

{
  "id": "id",
  "organizationId": "organizationId",
  "title": "title",
  "period": "QUARTERLY",
  "year": 1,
  "visibility": "PUBLIC",
  "weight": 1.1,
  "keyResults": [
    {
      "id": "id",
      "objectiveId": "objectiveId",
      "title": "title",
      "weight": 1.1,
      "priority": "P0",
      "draft": true,
      "sortOrder": 1,
      "ownerUserIds": [
        "ownerUserIds",
        "ownerUserIds"
      ],
      "ownerTeamIds": [
        "ownerTeamIds",
        "ownerTeamIds"
      ],
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "score": 1.1,
      "lastCheckInAt": "2024-01-15T09:30:00Z",
      "metric": {
        "name": "name",
        "kind": "WEBHOOK",
        "paused": true
      }
    },
    {
      "id": "id",
      "objectiveId": "objectiveId",
      "title": "title",
      "weight": 1.1,
      "priority": "P0",
      "draft": true,
      "sortOrder": 1,
      "ownerUserIds": [
        "ownerUserIds",
        "ownerUserIds"
      ],
      "ownerTeamIds": [
        "ownerTeamIds",
        "ownerTeamIds"
      ],
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "score": 1.1,
      "lastCheckInAt": "2024-01-15T09:30:00Z",
      "metric": {
        "name": "name",
        "kind": "WEBHOOK",
        "paused": true
      }
    }
  ],
  "draft": true,
  "sortOrder": 1,
  "archived": true,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "description": "description",
  "quarter": 1,
  "team": {
    "id": "id",
    "name": "name"
  },
  "teamId": "teamId",
  "owner": {
    "id": "id",
    "name": "name",
    "email": "email",
    "image": "image"
  },
  "ownerUserId": "ownerUserId",
  "score": 1.1
}

A key may change any objective. A signed-in session changes only one its person may edit in the app: they own it, are on its team (or a team inside it), created it, or are an app admin of OKR Hub. Anybody else gets 403 forbidden, and a Viewer of OKR Hub 403 viewer_only; an objective the person may not see is a 404, for an app admin too.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

objectiveIdstringRequired

Request

This endpoint expects an object.

titlestringOptional

descriptionstringOptional

periodenumOptional

Allowed values:

yearintegerOptional

quarterintegerOptional

visibilityenumOptional

Public objectives are browsable by everyone in the workspace. Private ones are visible to their owner, the members of the owning team, and whoever created them, whoever they belong to. The owners of its key results see it too.

Allowed values:

weightdoubleOptional

teamIdstringOptional

ownerUserIdstringOptional

draftbooleanOptional

false publishes it.

sortOrderintegerOptional

archivedbooleanOptional

Response

This endpoint returns an object.

idstring

organizationIdstring

titlestring

periodenum

Allowed values:

yearinteger

The fiscal year, 2000 to 2100, named by the year its Q1 falls in.

visibilityenum

Allowed values:

weightdouble

Relative weight when objectives roll up into an average, 0.01 to 100. One carrying twice the weight moves the average twice as much.

keyResultslist of objects

draftboolean

Still being worked out, not yet agreed. A label only: a draft is seen, scored, rolled up and checked in on like any other.

sortOrderinteger

Its place in the workspace's order of objectives, which is set by hand and which every list follows within a period.

archivedboolean

createdAtdatetime

updatedAtdatetime

descriptionstringOptional

quarterintegerOptional

1-4 for a quarterly objective, absent for an annual one.

teamobjectOptional

The team it belongs to. Absent, with owner, for an objective with no owner.

teamIdstringOptional

ownerobjectOptional

The person it belongs to. Absent, with team, for an objective with no owner.

ownerUserIdstringOptional

scoredoubleOptional

The weighted average of its key results’ grades, or absent when none has been scored. Absent rather than 0.0 on purpose: an unscored objective has not failed, and a zero would say it had.

Errors

403

Forbidden Error

404

Not Found Error

422

Validation Error

429

Too Many Requests Error