Skip to navigation
API ReferenceOkr

Import Objectives

Bulk entry: a period’s objectives and their key results from pasted text, as the dashboard’s Bulk entry page makes them. Lines it cannot read are skipped and listed in problems. A person or team the workspace does not have, or an objective naming more than one owner (an objective has one: a person or a team), stops the whole import with a 422, and details.problem names the line, its reason (notMember, notTeam or oneOwner) and the addresses or #team-slugs at fault in emails. Needs objectives:write and keyResults:write. Anybody with a seat may but a Viewer of OKR Hub, as with createObjective; the activity feed says the objectives were imported, for a key under the name of whoever made the key.

Expensive: besides the caller’s own limits, it counts against okr-bulk (see “Rate limits”).

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
textstringRequired
The pasted text, at most 100,000 characters.
yearintegerRequired
The fiscal year, 2000 to 2100.
periodenumOptional
Defaults to QUARTERLY.
Allowed values:
quarterintegerOptional

1 to 4; needed for a QUARTERLY period.

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:
draftbooleanOptional

Every objective a draft. Defaults to false; [draft] on a line marks just that one.

teamIdstringOptional

The team that owns the lines naming nobody. Never with ownerUserId.

ownerUserIdstringOptional

The person who owns the lines naming nobody. Never with teamId.

Response

This endpoint returns an object.
createdinteger
How many objectives were made.
objectiveIdslist of strings
Their ids, in the order they were pasted.
skippedinteger
How many lines could not be read.
problemslist of objects
Those lines, and why.

Errors

402
Subscription Required Error
403
Forbidden Error
422
Validation Error
429
Too Many Requests Error