@shortcut/client
    Preparing search index...

    Interface UpdateObjectiveParams

    interface UpdateObjectiveParams {
        archived?: boolean;
        category_ids?: number[];
        category_ids_add?: number[];
        category_ids_remove?: number[];
        completed_at_override?: string | null;
        description?: string;
        name?: string;
        owner_ids?: string[];
        owner_ids_add?: string[];
        owner_ids_remove?: string[];
        started_at_override?: string | null;
        state?: "done" | "in progress" | "to do";
        team_ids?: string[];
        team_ids_add?: string[];
        team_ids_remove?: string[];
    }
    Index

    Properties

    archived? category_ids? category_ids_add? category_ids_remove? completed_at_override? description? name? owner_ids? owner_ids_add? owner_ids_remove? started_at_override? state? team_ids? team_ids_add? team_ids_remove?

    Properties

    archived?: boolean

    Whether the Objective is archived.

    category_ids?: number[]

    An array of IDs of Categories to set on the Objective. Replaces current Categories.

    category_ids_add?: number[]

    An array of IDs of Categories to add to the Objective.

    category_ids_remove?: number[]

    An array of IDs of Categories to remove from the Objective.

    completed_at_override?: string | null

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

    date-time

    description?: string

    The Objective's description.

    100000

    name?: string

    The name of the Objective.

    1

    256

    owner_ids?: string[]

    An array of UUIDs for Members to set as Owners. This will replace the current Owners on the Objective. Sending an empty array will delete all existing Owners.

    owner_ids_add?: string[]

    An array of UUIDs for Members to add as Owners. These will be added to the current Owners on the Objective.

    owner_ids_remove?: string[]

    An array of UUIDs for Members to remove as Owners. These will be removed from the current Owners on the Objective.

    started_at_override?: string | null

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

    date-time

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

    The workflow state of the Objective.

    team_ids?: string[]

    An array of UUIDs for Teams to associate with the Objective. This will replace the current Teams on the Objective. Sending an empty array will remove all existing Teams.

    team_ids_add?: string[]

    An array of UUIDs for Teams to add to the Objective. These will be added to the current Teams on the Objective.

    team_ids_remove?: string[]

    An array of UUIDs for Teams to remove from the Objective. These will be removed from the current Teams on the Objective.

    Settings

    Member Visibility

    On This Page

    Properties