Lists
This section shows the available routes related to AcyMailing lists
Get lists
GET
https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=api&task=getLists
Gets all AcyMailing lists or lists by ID
Query Parameters
Name | Type | Description |
---|---|---|
offset | Int | Defaults to 0. Used for pagination, skips the first X results. |
limit | Int | Defaults to 100. Used for pagination, limits the number of results. |
filters | Array | You can filter users by column value. For example the id, active status or confirmation status. Available filters: [ "id": 421, "name": "test", "active": 0 ] |
Headers
Name | Type | Description |
---|---|---|
Api-Key* | String | The API key of a valid AcyMailing license used in the AcyMailing configuration page, tab "License". |
Create a list
POST
https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=api&task=createList
The parameters must be sent in JSON format inside the request's body.
Headers
Name | Type | Description |
---|---|---|
Api-Key* | String | The API key of a valid AcyMailing license used in the AcyMailing configuration page, tab "License". |
Content-Type* | String | application/json |
Request Body
Name | Type | Description |
---|---|---|
name* | String | The name of the new list |
active | Int | Defaults to 1. 1 = list active 2 = list inactive |
color | String | The hexadecimal color code. For example #3366ff |
welcomeId | Int | The ID of the AcyMailing mail to send when a user subscribes to this list. |
unsubscribeId | Int | The ID of the AcyMailing mail to send when a user unsubscribes from this list. |
visible | Int | Defaults to 1. 1 = list visible 2 = list invisible An invisible list won't be shown on subscription forms. These are generally management lists. |
Delete a list
DELETE
https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=api&task=deleteList
This deletes an AcyMailing list
Query Parameters
Name | Type | Description |
---|---|---|
listId* | Int | The ID corresponding to the AcyMailing list to delete |
Headers
Name | Type | Description |
---|---|---|
Api-Key* | String | The API key of a valid AcyMailing license used in the AcyMailing configuration page, tab "License". |
Last updated