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 include fields you want to update.

Parameter	Type	Description
name	string	List name (max 255 characters)
description	string|null	Public description (max 1000 characters). Send null to clear.
is_public	boolean	Whether the list is public

Example Request

curl -X PATCH "https://email.easy.tools/api/v1/lists/list-uuid-123" \
  -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/list-uuid-123" \
  -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": "list-uuid-123",
    "name": "Updated Newsletter",
    "description": "Updated description",
    "is_public": true,
    "contacts_count": 150,
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-16T14:00:00Z"
  }
}

Response Fields

Field	Type	Description
uuid	string	List's unique identifier
name	string	List name
description	string|null	Public description
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)

Error Responses

Not Found Error (404)

{
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "List with uuid 'list-uuid-123' not found"
  }
}

Validation Error (422 Unprocessable Entity)

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