Cavemanon/piratepoet
7
Fork 0
Code Pull Requests Actions Releases 16 Activity

Update Public API documentation

Browse Source 
MAILPOET-6056
This commit is contained in:
Oluwaseun Olorunsola
2024-05-03 10:07:39 +01:00
committed by Aschepikov
parent f91812b1da
commit 7a10fbb8ff
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/api_methods/AddList.md
View File

@ -1,6 +1,6 @@
[back to list](../Readme.md) [back to list](../Readme.md)
# Add Subscriber # Add List
## `array addList(array $list)` ## `array addList(array $list)`

12
doc/api_methods/UpdateList.md
View File

@ -1,6 +1,6 @@
[back to list](../Readme.md) [back to list](../Readme.md)
# Add Subscriber # Update List
## `array updateList(array $list)` ## `array updateList(array $list)`
@ -14,11 +14,11 @@ It returns the updated list. See [Get Lists](GetLists.md) for a list data struct
An associative array which contains list data. An associative array which contains list data.
| Property | Type | Limits | Description | | Property | Type | Limits | Description |
| ---------------------- | ------------ | --------- | -------------------------- | | ---------------------- | ------------ | --------- | -------------------------------------------------------------------------- |
| id (required) | string | 11 chars | A id of the list. | | id (required) | string | 11 chars | A id of the list. |
| name (required) | string | 90 chars | A name of the list. | | name (required) | string | 90 chars | A name of the list. |
| description (optional) | string\|null | 250 chars | A description of the list. | | description (optional) | string\|null | 250 chars | A description of the list. This will reset the list description when empty |
## Error handling ## Error handling