diff --git a/docs/docs/content/apis/lists.md b/docs/docs/content/apis/lists.md index bf5753b47..4db390691 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.yaml index 6dabe6233..bf416160d 100644 --- a/docs/swagger/collections.yaml +++ b/docs/swagger/collections.yaml @@ -3697,6 +3697,8 @@ components: type: string subscriber_count: type: integer + description: + type: string NewList: type: object @@ -3713,6 +3715,8 @@ components: type: array items: type: string + description: + type: string ImportStatus: type: object