From 8a493c8c6521d283e82b743b54c6d1ae7498d422 Mon Sep 17 00:00:00 2001 From: Zhang Huangbin Date: Sat, 30 Dec 2017 13:22:04 +0800 Subject: [PATCH] Update iRedAdmin-Pro API doc. --- .../0-iredadmin-pro.restful.api.new.md | 11 +++++++++- html/iredadmin-pro.restful.api.new.html | 22 ++++++++++++++++++- 2 files changed, 31 insertions(+), 2 deletions(-) diff --git a/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md b/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md index 10b28dcc..feedd327 100644 --- a/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md +++ b/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md @@ -404,7 +404,16 @@ Notes: -!!! api "`DELETE`{: .delete } `/api/maillist/`{: .url } `Delete an existing mailing list`{: .comment }" +!!! api "`DELETE`{: .delete } `/api/maillist/`{: .url } `Delete an existing mailing list`{: .comment } `Parameters`{: .has_params }" + +
+ + Parameter | Summary | Sample Usage + --- |--- |--- + `archive` | Archive subscribable mailing list before deleting the account. NOTE: This option is only applicable to the subscribable mailing list account. | `archive=no` + +
+ !!! api "`PUT`{: .put } `/api/maillist/`{: .url } `Update profile of an existing mailing list`{: .comment } `Parameters`{: .has_params }"
diff --git a/html/iredadmin-pro.restful.api.new.html b/html/iredadmin-pro.restful.api.new.html index 8d1d627c..71c14e8f 100644 --- a/html/iredadmin-pro.restful.api.new.html +++ b/html/iredadmin-pro.restful.api.new.html @@ -1095,7 +1095,27 @@ please use mail alias account as mailing list.

-

DELETE /api/maillist/<mail> Delete an existing mailing list

+

DELETE /api/maillist/<mail> Delete an existing mailing list Parameters

+
+ + + + + + + + + + + + + + + + +
ParameterSummarySample Usage
archiveArchive subscribable mailing list before deleting the account. NOTE: This option is only applicable to the subscribable mailing list account.archive=no
+
+

PUT /api/maillist/<mail> Update profile of an existing mailing list Parameters