Skip to main content
PUT
/
api
/
v1
/
contact-lists
/
{id}
Update List
curl --request PUT \
  --url https://api.example.com/api/v1/contact-lists/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "customFields": [
    {
      "key": "<string>",
      "label": "<string>",
      "type": "<string>",
      "required": true,
      "defaultValue": "<any>",
      "options": [
        "<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.

Update properties of an existing contact list including name, description, and custom fields.

​
Path Parameters

​
id
string
required
The unique list ID (e.g., lst_abc123).

​
Request Body

​
name
string
New list name (max 100 characters).
​
description
string
New description (max 500 characters).
​
customFields
array
Updated custom field definitions. Replaces existing fields.

​
Examples

import { MailBreeze } from "mailbreeze";

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

// Update name and description
const list = await mailbreeze.lists.update("lst_abc123", {
  name: "Premium Newsletter",
  description: "Updated description",
});

// Add new custom field
const list = await mailbreeze.lists.update("lst_abc123", {
  customFields: [
    { key: "company", label: "Company", type: "text" },
    { key: "industry", label: "Industry", type: "select", options: ["tech", "finance", "healthcare"] },
  ],
});

console.log(list.updatedAt); // "2024-01-20T14:15:00Z"

​
Response

Returns the updated contact list object.
Example Response
{
  "success": true,
  "data": {
    "domainId": "6911cf4253eb3ff3b4de6215",
    "userId": "68da571fdc22fcf0773dcb33",
    "name": "Premium Newsletter",
    "description": "Updated description",
    "totalContacts": 1523,
    "activeContacts": 1520,
    "suppressedContacts": 3,
    "tags": [],
    "createdAt": "2025-12-27T11:22:14.221Z",
    "updatedAt": "2025-12-27T14:15:00.000Z",
    "id": "694fc1669e63563857ae8d72"
  },
  "meta": {
    "timestamp": "2025-12-27T14:15:00.123Z",
    "requestId": "abc123-def456",
    "path": "/api/v1/contact-lists/694fc1669e63563857ae8d72"
  }
}

​
Errors

CodeHTTP StatusDescription
NOT_FOUND404List with this ID doesn’t exist
VALIDATION_ERROR400Invalid field values or format
Updating customFields replaces the entire array. Include all fields you want to keep.