Emails

This section shows the available routes related to AcyMailing emails

Get users

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

Gets emails created in AcyMailing (campaigns, notifications, overrides, templates, etc...)

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 emails by type and search by name: [ "search": "christmas", "type": "standard" ] Available types are: - standard - notification - override - welcome - unsubscribe - automation - followup - template

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 emails or an empty array

[
    {
        "id": "81",
        "name": "New year newsletter",
        "creation_date": "2024-12-27 14:53:54",
        "subject": "Happy new year!"
    }
]

422: Unprocessable Entity When the type specified in the filter does not exist

{
    "message": "Invalid type."
}

Send an email to a user

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

This sends an email by ID to a single user, existing or not

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 of the receiver.
autoAddUser	Bool	Defaults to false. If the email address doesn't match an existing AcyMailing user, one will be automatically created if this option is set to true.
emailId*	Int	The mail ID to send. This is not a campaign ID but the mail ID of the table xxx_acym_mail in the database, or the mail_id of a campaign.
trackEmail	Bool	Defaults to true. If true, the open/click statistics will be collected for this email.
params	Array	An optional array of shortcodes and values to replace in the body of the sent email. Example: [ "shortcode1": "value 1" ] If the body of the sent email contains the text "{shortcode1}", it will be replaced by "value 1" in the sent version.

200: OK The email has been sent

{
    "message": "Email sent successfully."
}

404: Not Found The provided data don't match existing elements

{
    "message": "User doesn't exist"
}

{
    "message": "Email doesn't exist"
}

422: Unprocessable Entity Missing parameters

{
    "message": "Receiver email address not provided in the request body."
}

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

500: Internal Server Error An error occurred

{
    "message": "Error sending."
}