@wppconnect/wa-js/dist/lists/functions/create.d.ts

WPPConnect/WA-JS is an open-source project with the aim of exporting functions from WhatsApp Web

/*!
 * Copyright 2026 WPPConnect Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { Wid } from '../../whatsapp';
/**
 * Create a new list and optionally add chats to it.
 * Works for both personal and business accounts.
 *
 * @example
 * ```javascript
 * const id = await WPP.lists.create('Family', ['number@c.us', 'number2@c.us']);
 * console.log(id); // '42'
 * ```
 *
 * @category Lists
 */
export declare function create(name: string, chatIds?: (string | Wid)[], colorIndex?: number): Promise<string>;