Interface UpdateObjective

interface UpdateObjective {
    after_id?: number;
    archived?: boolean;
    before_id?: number;
    categories?: CreateCategoryParams[];
    completed_at_override?: string;
    description?: string;
    name?: string;
    started_at_override?: string;
    state?: "done" | "in progress" | "to do";
}

Properties

after_id? archived? before_id? categories? completed_at_override? description? name? started_at_override? state?

Properties

Optionalafter_id

after_id?: number

The ID of the Objective we want to move this Objective after.

Format

int64

Optionalarchived

archived?: boolean

A boolean indicating whether the Objective is archived or not

Optionalbefore_id

before_id?: number

The ID of the Objective we want to move this Objective before.

Format

int64

Optionalcategories

categories?: CreateCategoryParams[]

An array of IDs of Categories attached to the Objective.

Optionalcompleted_at_override

completed_at_override?: string

A manual override for the time/date the Objective was completed.

Format

date-time

Optionaldescription

description?: string

The Objective's description.

Max Length

100000

Optionalname

name?: string

The name of the Objective.

Min Length

1

Max Length

256

Optionalstarted_at_override

started_at_override?: string

A manual override for the time/date the Objective was started.

Format

date-time

Optionalstate

state?: "done" | "in progress" | "to do"

The workflow state that the Objective is in.

Settings

Member Visibility

On This Page

Properties