Users

This section shows the available routes related to AcyMailing users

Get users

GET https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=api&task=getUsers

Gets AcyMailing users based on optional criteria

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, "cms_id": 828, "email": "[e-mail]", "active": 1 "confirmed": 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 list of found users or an empty array

[
    {
        "id": "1",
        "name": "The user name",
        "email": "[e-mail]",
        "creation_date": "2023-07-19 13:44:08",
        "active": "1",
        "cms_id": "1",
        "source": null,
        "confirmed": "1",
        "key": "doZaVzX4jQezQf",
        "automation": "",
        "confirmation_date": null,
        "confirmation_ip": null,
        "tracking": "1",
        "language": "en-US",
        "last_sent_date": "2024-01-05 15:57:41",
        "last_open_date": "2023-10-04 12:17:48",
        "last_click_date": null
    }
]

Create or update a user

POST https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=api&task=createOrUpdateUser

Add a new AcyMailing user or update an existing one

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
email*	String	The email address is used when updating an existing user
name	String	Any character should be available
active	Int	Defaults to 1. 1 = user active 0 = user inactive
confirmed	Int	Defaults to 0. 1 = user confirmed 0 = user not confirmed The confirmation is related to the "Require confirmation" option in the configuration, tab "Subscription".
cms_id	Int	Defaults to 0. The cms_id must match the ID of the corresponding Joomla/WordPress user.
customFields	Array	Must be couples of field IDs and values. For example: [ "3": "My value", "5": [ "one", "two" ] ]
triggers	Bool	Defaults to true. Defines if the saving of the user triggers automated tasks like follow-up campaigns and automations.
sendConf	Bool	Defaults to true. Defines if the confirmation email should be sent when a new user is created.

201: Created When the user has been created/updated

{
    "userId": 21
}

422: Unprocessable Entity The email address is missing

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

500: Internal Server Error An error occurred when creating/updating the user

{
    "message": "Error saving user.",
    "errors": [
        "Please enter a valid e-mail address"
    ]
}

Delete a user

DELETE https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=api&task=deleteUser

This deletes an AcyMailing user by email or ID

Query Parameters

Name	Type	Description
email	String	The email address corresponding to the AcyMailing user to delete. Required if the ID parameter is missing.
userId	Int	The ID corresponding to the AcyMailing user 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": "User deleted."
}

404: Not Found When the searched user was not found

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

422: Unprocessable Entity A required parameter is missing

{
    "message": "Email or user ID not provided in query parameters."
}

500: Internal Server Error When an error occurs during deletion

{
    "message": "Error deleting user.",
    "errors": [...]
}