High performance, self-hosted, newsletter and mailing list manager with a modern dashboard. Single binary app.
JavaScript campaigncampaign-managementemail-marketingemail-subscriptionlistmonkmailing-listnewsletternewsletter-managementnewsletter-softwareself-hostedsms-gatewaysmtptransactional-emails
adds property `description` to `List` and `NewList`, updates docs (#2150)
Ulf Seltmann8b213f099656
diff --git a/docs/docs/content/apis/lists.md b/docs/docs/content/apis/lists.mdindex bf5753b4..4db39069 100644--- a/docs/docs/content/apis/lists.md+++ b/docs/docs/content/apis/lists.md@@ -143,6 +143,7 @@ Create a new list.| type | string | Yes | Type of list. Options: private, public. || optin | string | Yes | Opt-in type. Options: single, double. || tags | string\[\] | | Associated tags for a list. |+| description | string | No | Description of the new list. |##### Example Request@@ -162,7 +163,8 @@ curl -u "username:password" -X POST 'http://localhost:9000/api/lists'"name": "Test list","type": "public","tags": [],- "subscriber_count": 0+ "subscriber_count": 0,+ "description": "This is a test list"}}null@@ -183,6 +185,7 @@ Update a list.| type | string | | Type of list. Options: private, public. || optin | string | | Opt-in type. Options: single, double. || tags | string\[\] | | Associated tags for the list. |+| description | string | | Description of the new list. |##### Example Request@@ -205,7 +208,8 @@ curl -u "username:password" -X PUT 'http://localhost:9000/api/lists/5' \"type": "private","optin": "single","tags": [],- "subscriber_count": 0+ "subscriber_count": 0,+ "description": "This is a test list"}}```diff --git a/docs/swagger/collections.yaml b/docs/swagger/collections.yamlindex 6dabe623..bf416160 100644--- a/docs/swagger/collections.yaml+++ b/docs/swagger/collections.yaml@@ -3697,6 +3697,8 @@ components:type: stringsubscriber_count:type: integer+ description:+ type: stringNewList:type: object@@ -3713,6 +3715,8 @@ components:type: arrayitems:type: string+ description:+ type: stringImportStatus:type: object