Update List

Partially update a list. Only provided fields will be updated.

Request

PATCH /lists/{uuid}

Path Parameters

Parameter	Type	Description
uuid	string	List's UUID

Request Body

All fields are optional. Only fields included in the body are changed; omit a field to leave it untouched.

Parameter	Type	Description
name	string	List name (max 255 characters). A null or empty value is ignored; the name cannot be cleared.
description	string|null	Public-facing description, shown on your account's public subscription page (max 1000 characters). Send null to clear.
internal_description	string|null	Private, account-internal note (max 1000 characters). Never shown to subscribers. Send null to clear.
is_public	boolean	Whether the list is public. A null value is ignored.

Example Request

curl -X PATCH "https://email.easy.tools/api/v1/lists/70dbd819-fac2-4dcf-b655-fb925e24410b" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "Updated Newsletter",
    "description": "Updated description"
  }'

Example Request (clearing description)

curl -X PATCH "https://email.easy.tools/api/v1/lists/70dbd819-fac2-4dcf-b655-fb925e24410b" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "description": null
  }'

Response

Success Response (200 OK)

{
  "data": {
    "uuid": "70dbd819-fac2-4dcf-b655-fb925e24410b",
    "name": "Updated Newsletter",
    "description": "Updated description",
    "internal_description": "Imported from the 2024 CRM export",
    "is_public": true,
    "contacts_count": 150,
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-16T14:00:00Z"
  }
}

Response Fields

The updated list has the fields described in List Object.

Error Responses

Not Found Error (404)

{
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "List with uuid '70dbd819-fac2-4dcf-b655-fb925e24410b' not found"
  }
}

Validation Error (422 Unprocessable Entity)

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The given data was invalid",
    "details": {
      "name": ["The name field must not be greater than 255 characters."]
    }
  }
}