Add deleteList documentation
[MAILPOET-4752]
This commit is contained in:
@@ -28,6 +28,7 @@ Class `\MailPoet\API\API` becomes available once MailPoet plugin is loaded by Wo
|
|||||||
- [Add List (addList)](api_methods/AddList.md)
|
- [Add List (addList)](api_methods/AddList.md)
|
||||||
- [Add Subscriber (addSubscriber)](api_methods/AddSubscriber.md)
|
- [Add Subscriber (addSubscriber)](api_methods/AddSubscriber.md)
|
||||||
- [Add Subscriber Field (addSubscriberField)](api_methods/AddSubscriberField.md)
|
- [Add Subscriber Field (addSubscriberField)](api_methods/AddSubscriberField.md)
|
||||||
|
- [Delete List (deleteList)](api_methods/DeleteList.md)
|
||||||
- [Get Lists (getLists)](api_methods/GetLists.md)
|
- [Get Lists (getLists)](api_methods/GetLists.md)
|
||||||
- [Get Subscriber (getSubscriber)](api_methods/GetSubscriber.md)
|
- [Get Subscriber (getSubscriber)](api_methods/GetSubscriber.md)
|
||||||
- [Get Subscribers (getSubscribers)](api_methods/GetSubscribers.md)
|
- [Get Subscribers (getSubscribers)](api_methods/GetSubscribers.md)
|
||||||
|
26
doc/api_methods/DeleteList.md
Normal file
26
doc/api_methods/DeleteList.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
[back to list](../Readme.md)
|
||||||
|
|
||||||
|
# Delete List
|
||||||
|
|
||||||
|
## `bool deleteList(string $list_id)`
|
||||||
|
|
||||||
|
This method provides functionality for deleting a new list.
|
||||||
|
|
||||||
|
It returns a boolean value.
|
||||||
|
|
||||||
|
## Error handling
|
||||||
|
|
||||||
|
All expected errors from the API are exceptions of class `\MailPoet\API\MP\v1\APIException`.
|
||||||
|
Code of the exception is populated to distinguish between different errors.
|
||||||
|
|
||||||
|
An exception of base class `\Exception` can be thrown when something unexpected happens.
|
||||||
|
|
||||||
|
Codes description:
|
||||||
|
|
||||||
|
| Code | Description |
|
||||||
|
| ---- | --------------------------------------------------------------- |
|
||||||
|
| 5 | List does not exist |
|
||||||
|
| 18 | List id is empty |
|
||||||
|
| 20 | List cannot be deleted because it’s used for an automatic email |
|
||||||
|
| 21 | List cannot be deleted because it’s used for a form |
|
||||||
|
| 22 | The list couldn’t be deleted from the database |
|
Reference in New Issue
Block a user