Skip to main content
POST
/
api
/
v1
/
contact-lists
Create List
curl --request POST \
  --url https://api.example.com/api/v1/contact-lists \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "customFields": [
    {
      "key": "<string>",
      "label": "<string>",
      "type": "<string>",
      "required": true,
      "defaultValue": "<any>",
      "options": [
        "<string>"
      ]
    }
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "customFields": [
    {}
  ],
  "contactCount": 123,
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.mailbreeze.com/llms.txt

Use this file to discover all available pages before exploring further.

Create a new contact list for organizing email recipients with optional custom field definitions.

​
Request Body

​
name
string
required
List name (max 100 characters).
​
description
string
Optional description (max 500 characters).
​
customFields
array
Custom field definitions for contacts in this list.

​
Examples

import { MailBreeze } from "mailbreeze";

const mailbreeze = new MailBreeze({ apiKey: "sk_live_xxx" });

// Simple list
const list = await mailbreeze.lists.create({
  name: "Newsletter Subscribers",
  description: "Weekly newsletter recipients",
});

// List with custom fields
const list = await mailbreeze.lists.create({
  name: "VIP Customers",
  description: "High-value customers",
  customFields: [
    { key: "company", label: "Company", type: "text" },
    { key: "revenue", label: "Annual Revenue", type: "number" },
    { key: "plan", label: "Plan", type: "select", options: ["free", "pro", "enterprise"] },
    { key: "signupDate", label: "Signup Date", type: "date" },
    { key: "isActive", label: "Active", type: "boolean", defaultValue: true },
  ],
});

console.log(list.id); // "lst_xxx"

​
Response

​
id
string
Unique list ID.
​
name
string
List name.
​
description
string
List description.
​
customFields
array
Custom field definitions.
​
contactCount
integer
Number of contacts (0 for new lists).
​
createdAt
string
ISO 8601 timestamp when created.
​
updatedAt
string
ISO 8601 timestamp when last updated.
Example Response
{
  "success": true,
  "data": {
    "domainId": "6911cf4253eb3ff3b4de6215",
    "userId": "68da571fdc22fcf0773dcb33",
    "name": "VIP Customers",
    "description": "High-value customers",
    "totalContacts": 0,
    "activeContacts": 0,
    "suppressedContacts": 0,
    "tags": [],
    "createdAt": "2025-12-27T12:46:07.070Z",
    "updatedAt": "2025-12-27T12:46:07.070Z",
    "id": "694fd50f9e63563857ae96bb"
  },
  "meta": {
    "timestamp": "2025-12-27T12:46:07.123Z",
    "requestId": "abc123-def456",
    "path": "/api/v1/contact-lists"
  }
}

​
Custom Field Types

TypeDescriptionExample Value
textFree-form text"Acme Corp"
numberNumeric value99.99
dateISO 8601 date"2024-01-15"
booleanTrue/falsetrue
selectSingle choice from options"pro"
Custom fields are defined at the list level. All contacts in a list share the same field schema.