---
title: "Creates a new email list"
method: POST
path: "/api/lists"
tags: ["Lists"]
---

# Creates a new email list

`POST /api/lists`

## Request

- Base URL: `https://api.gmass.co`
- URL: `https://api.gmass.co/api/lists`
- Auth: none declared

Creates a new list and returns a GMass list address alias

## Request body

- List
  - `listAddress` string: The GMass-generated address to represent an email list. Looks like aaabbb-cccc@gmass.co
  - `listSource` ListSource
    - `listSourceSheet` ListSourceSheet
      - `spreadsheetId` string: The "id" value of the Google Sheet. Can be retrieved from the sheets.google.com URL
      - `worksheetId` string: The Google assigned ID of the worksheet within a Google Sheet. The default worksheet usually has an ID of 0.
      - `spreadsheetName` string: The name of the Google Sheet
      - `worksheetName` string: The name of the tab (worksheet) inside the Google Sheet
      - `KeepDuplicates` boolean: Whether duplicates should be kept or filtered out. Set to true or false.
      - `FilterCriteria` string: A string value representing a filter of rows in the Sheet. See https://www.gmass.co/blog/send-mail-merge-to-selected-rows-spreadsheet/
      - `AndOr` string: If FilterCriteria specified, then specify whether the criteria should be joined by a boolean AND or OR. The default is AND. Specify as "And" or "Or".
      - `UpdateSheet` boolean: Whether GMass should update the Sheet with additional columns to track reporting data. Set to true or false.

## Response `200`

OK

- List
  - `listAddress` string: The GMass-generated address to represent an email list. Looks like aaabbb-cccc@gmass.co
  - `listSource` ListSource
    - `listSourceSheet` ListSourceSheet
      - `spreadsheetId` string: The "id" value of the Google Sheet. Can be retrieved from the sheets.google.com URL
      - `worksheetId` string: The Google assigned ID of the worksheet within a Google Sheet. The default worksheet usually has an ID of 0.
      - `spreadsheetName` string: The name of the Google Sheet
      - `worksheetName` string: The name of the tab (worksheet) inside the Google Sheet
      - `KeepDuplicates` boolean: Whether duplicates should be kept or filtered out. Set to true or false.
      - `FilterCriteria` string: A string value representing a filter of rows in the Sheet. See https://www.gmass.co/blog/send-mail-merge-to-selected-rows-spreadsheet/
      - `AndOr` string: If FilterCriteria specified, then specify whether the criteria should be joined by a boolean AND or OR. The default is AND. Specify as "And" or "Or".
      - `UpdateSheet` boolean: Whether GMass should update the Sheet with additional columns to track reporting data. Set to true or false.

---

[API](https://skmtc.dev/gmass/apis/gmass-api.md) - [All operations](https://skmtc.dev/gmass/apis/gmass-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gmass/apis/gmass-api/revisions/0498e4a9c765?raw)