Lists
Lists allow you to organize your contacts into groups for targeted email campaigns. The Lists API allows you to create, retrieve, update, and delete lists.
Overview
Each list has a name and two optional descriptions: a public description shown on your account's public subscription page, and a private internal_description that subscribers never see, kept for your own reference. Contacts can belong to multiple lists simultaneously. Lists can be public (shown in subscription preferences) or private.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /lists | Create a new list |
| GET | /lists | List all lists |
| GET | /lists/{uuid} | Get a specific list |
| PATCH | /lists/{uuid} | Update a list |
| DELETE | /lists/{uuid} | Delete a list |
List Object
| Field | Type | Description |
|---|---|---|
uuid | string | Unique identifier for the list |
name | string | List name |
description | string|null | Public-facing description, shown on your account's public subscription page |
internal_description | string|null | Private, account-internal note. Never shown to subscribers. |
is_public | boolean | Whether the list is public |
contacts_count | integer | Number of contacts in the list |
created_at | string | ISO 8601 timestamp (UTC) |
updated_at | string | ISO 8601 timestamp (UTC) |