Create List
Create a new contact list in your account.
Request
POST /lists
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | List name (max 255 characters) |
description | string|null | No | Public-facing description, shown on your account's public subscription page (max 1000 characters) |
internal_description | string|null | No | Private, account-internal note (max 1000 characters). Never shown to subscribers. |
is_public | boolean | No | Whether the list is public (default: true) |
Example Request
curl -X POST "https://email.easy.tools/api/v1/lists" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"name": "Newsletter Subscribers",
"description": "Main newsletter list",
"internal_description": "Imported from the 2024 CRM export",
"is_public": true
}'
Response
Success Response (201 Created)
{
"data": {
"uuid": "70dbd819-fac2-4dcf-b655-fb925e24410b",
"name": "Newsletter Subscribers",
"description": "Main newsletter list",
"internal_description": "Imported from the 2024 CRM export",
"is_public": true,
"contacts_count": 0,
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T10:30:00Z"
}
}
Response Fields
The created list has the fields described in List Object.
Error Responses
Validation Error (422 Unprocessable Entity)
{
"error": {
"code": "VALIDATION_ERROR",
"message": "The given data was invalid",
"details": {
"name": ["The name field is required."]
}
}
}