listmonk unofficial
POST/lists

Create a mailing list

Creates a mailing list from the supplied list details. Provide name, type, optin, tags, or description as needed; type and optin have defined accepted values. The response includes the created list and its metadata.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

5 body fields

Mailing list details to create; all fields are optional in the schema.

namestringoptional
The name of the mailing list.
typestringoptional
The list visibility type: public or private.
Allowed:publicprivate
optinstringoptional
The subscription confirmation mode: single or double opt-in.
Allowed:singledouble
tagsarray<string>optional
Tags to associate with the list, as an array of strings.
descriptionstringoptional
A description of the mailing list.

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

Error handling

type, when provided, must be public or private, and optin must be single or double. tags must be an array of strings.