Function: archiveList()

function archiveList(client, parameters): Promise<{
  closed?: boolean;
  color?: string | null;
  creationMethod?: unknown;
  datasource?: {
     filter?: boolean;
  };
  id: string;
  idBoard?: string;
  idOrganization?: string | null;
  limits?: {
     attachments?: {
        perBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        perCard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     boards?: {
        totalAccessRequestsPerBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        totalMembersPerBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        totalPerMember?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     cards?: {
        openPerBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        openPerList?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        totalPerBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        totalPerList?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     checkItems?: {
        perChecklist?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     checklists?: {
        perBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        perCard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     customFieldOptions?: {
        perField?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     customFields?: {
        perBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     labels?: {
        perBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     lists?: {
        openPerBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        totalPerBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     orgs?: {
        freeBoardsPerOrg?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        totalMembersPerOrg?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        totalPerMember?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        usersPerFreeOrg?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     reactions?: {
        perAction?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        uniquePerAction?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     stickers?: {
        perCard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
  };
  name?: string;
  nodeId?: string;
  pos?: number;
  softLimit?: string | null;
  subscribed?: boolean;
  type?: string | null;
}>;

Defined in: api/lists.ts:93

Archive or unarchive a list

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ id: unknown; value?: unknown; }	-
parameters.id	unknown	The ID of the list
parameters.value?	unknown	Set to true to close (archive) the list

Returns

Promise<{ closed?: boolean; color?: string | null; creationMethod?: unknown; datasource?: { filter?: boolean; }; id: string; idBoard?: string; idOrganization?: string | null; limits?: { attachments?: { perBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; perCard?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; boards?: { totalAccessRequestsPerBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalMembersPerBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalPerMember?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; cards?: { openPerBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; openPerList?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalPerBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalPerList?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; checkItems?: { perChecklist?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; checklists?: { perBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; perCard?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; customFieldOptions?: { perField?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; customFields?: { perBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; labels?: { perBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; lists?: { openPerBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalPerBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; orgs?: { freeBoardsPerOrg?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalMembersPerOrg?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalPerMember?: { count?: number; disableAt: number; status: string; warnAt: number; }; usersPerFreeOrg?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; reactions?: { perAction?: { count?: number; disableAt: number; status: string; warnAt: number; }; uniquePerAction?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; stickers?: { perCard?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; }; name?: string; nodeId?: string; pos?: number; softLimit?: string | null; subscribed?: boolean; type?: string | null; }>