Function: createChecklist()
function createChecklist(client, parameters): Promise<{
checkItems?: object[];
id: string;
idBoard?: string;
idCard?: string;
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;
pos?: number;
}>;Defined in: api/checklists.ts:21
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { idCard: unknown; idChecklistSource?: unknown; name?: string; pos?: unknown; } | - |
parameters.idCard | unknown | The ID of the Card that the checklist should be added to. |
parameters.idChecklistSource? | unknown | The ID of a checklist to copy into the new checklist. |
parameters.name? | string | The name of the checklist. Should be a string of length 1 to 16384. |
parameters.pos? | unknown | The position of the checklist on the card. One of: top, bottom, or a positive number. |
Returns
Promise<{ checkItems?: object[]; id: string; idBoard?: string; idCard?: string; 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; pos?: number; }>