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".

200: OK The lists or an empty array.

[
    [
        {
            "id": "1",
            "name": "Newsletters",
            "display_name": null,
            "active": "1",
            "visible": "1",
            "clean": null,
            "color": "#3366ff",
            "creation_date": "2023-07-19 13:44:07",
            "welcome_id": "26",
            "unsubscribe_id": null,
            "cms_user_id": "1",
            "access": "",
            "description": "",
            "tracking": "1",
            "type": "standard",
            "translation": ""
        },
        {
            "id": "19",
            "name": "Testing list",
            "display_name": null,
            "active": "1",
            "visible": "0",
            "clean": null,
            "color": "#94d4a6",
            "creation_date": "2024-01-15 09:52:10",
            "welcome_id": null,
            "unsubscribe_id": null,
            "cms_user_id": "1",
            "access": "",
            "description": "",
            "tracking": "1",
            "type": "standard",
            "translation": ""
        }
    ]
]

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.

422: Unprocessable Entity List name is missing

{
    "message": "List name missing."
}

201: Created List created

{
    "listId": 20
}

500: Internal Server Error An error occurred

{
    "message": "Error creating list.",
    "errors": [...]
}

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".

200: OK Deletion went well

{
    "message": "List deleted."
}

500: Internal Server Error An error occurred

{
    "message": "Error deleting list."
}

422: Unprocessable Entity The list id is missing

{
    "message": "List id not provided in the request body."
}

404: Not Found List not found

{
    "message": "List not found."
}