listmonk unofficial
PUT/lists/{list_id}

Replace mailing list details

Replaces the supplied fields on a mailing list identified by its ID. The request body can include list settings, tags, and metadata; all body fields are optional in the schema.

1 parameter · 10 body fields
list_idintegerrequired
The integer ID of the mailing list to update.

Mailing list field values to apply; all fields are optional in the schema.

idintegeroptional
The list's integer ID.
created_atstringoptional
The list creation timestamp as a string.
updated_atstringoptional
The list update timestamp as a string.
uuidstringoptional
The list UUID as a string.
namestringoptional
The name of the mailing list.
typestringoptional
The mailing list type as a string.
optinstringoptional
The subscription confirmation mode as a string.
tagsarray<string>optional
Tags to associate with the list, as an array of strings.
subscriber_countintegeroptional
The subscriber count as an integer.
descriptionstringoptional
A description of the mailing list.

1 status code
200Returns the updated list object, including its identifier, timestamps, UUID, settings, tags, subscriber count, and description.
dataobjectoptional

Error handling

The list_id path parameter must be an integer identifying the list to update. tags, when provided, must be an array of strings; the schema does not define additional value constraints for the other fields.