Campaigns

This section shows the available routes related to AcyMailing campaigns

Get campaigns

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

Get a collection of campaigns

Query Parameters

Name	Type	Description
offset	Int	From which element in the database you would like to start getting campaign, by default it's set to 0
limit	Int	The number of campaigns you would like to get in your request, by default it's set to 100
filters[]	Array	Filter with any column in the campaign table and the columns name and subject of the mail table

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 An array of campaigns

500: Internal Server Error Database error

Get one Campaign

GET https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=api&task=getCampaignById&campaignId={id}

Get a campaign by id

Query Parameters

Name	Type	Description
campaignId*	Int	The ID of the campaign to get

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 campaign with the mail information

404: Not Found Campaign not found

422: Unprocessable Entity The ID of the campaign is missing from the request

Create or update a campaign

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

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

200: OK Campaign successfully updated

201: Created Campaign successfully created

404: Not Found Campaign not found

422: Unprocessable Entity Error in the campaign data provided

Example of JSON body:

1. If you want to create a simple campaign which will be sent when you call the send endpoint:

{
    "subject": "This is a test from the api",// Required
    "name": "Name of the campaign from the api", // Required
    "body": "This is the body of the email", // Not required
    "from_name": "Sender name", // Not required
    "from_email": "[email protected]", // Not required
    "reply_to_name": "No reply", // Not required
    "reply_to_email": "[email protected]", // Not required
    "bounce_email": "[email protected]", // Not required
    "bcc": "[email protected]", // Not required
    "sending_type": "now", // Default "now"
    "listIds": [1, 34, 11] // Not required
}

1. If you want to create a campaign and schedule it for later:

{
    "subject": "This is a test from the api",// Required
    "name": "Name of the campaign from the api", // Required
    "body": "This is the body of the email", // Not required
    "from_name": "Sender name", // Not required
    "from_email": "[email protected]", // Not required
    "reply_to_name": "No reply", // Not required
    "reply_to_email": "[email protected]", // Not required
    "bounce_email": "[email protected]", // Not required
    "bcc": "[email protected]", // Not required
    "sending_type": "scheduled", // Default "now"
    "sending_date": "2024-06-14",
    "listIds": [11] // Not required
}

1. If you want to create an automatic campaign which will be trigger every cron:

{
    "subject": "This is a test from the api",// Required
    "name": "Name of the campaign from the api", // Required
    "body": "This is the body of the email", // Not required
    "from_name": "Sender name", // Not required
    "from_email": "[email protected]", // Not required
    "reply_to_name": "No reply", // Not required
    "reply_to_email": "[email protected]", // Not required
    "bounce_email": "[email protected]", // Not required
    "bcc": "[email protected]", // Not required
    "sending_type": "auto", // Default is "now"
    "frequency": "cron", // Required if sending_type is auto, must be "every" or "cron"
    "need_confirm": 0, // Default is 1
    "start_date": "2024-05-22", // Not required
    "listIds": [1, 34, 11] // Not required
}

1. If you want to create an automatic campaign that will trigger every X hour, day, week or month:

{
    "subject": "This is a test from the api",// Required
    "name": "Name of the campaign from the api", // Required
    "body": "This is the body of the email", // Not required
    "from_name": "Sender name", // Not required
    "from_email": "[email protected]", // Not required
    "reply_to_name": "No reply", // Not required
    "reply_to_email": "[email protected]", // Not required
    "bounce_email": "[email protected]", // Not required
    "bcc": "[email protected]", // Not required
    "sending_type": "auto", // Default is "now"
    "frequency": "every", // Required if sending_type is set to "auto", must be "every" or "cron"
    "frequency_options": { // Required if frequency is set to "every"
        "unit": "month", // Must be "hour", "day", "week" or "month"
        "value": 12
    },
    "need_confirm": 0, // Default is 1
    "start_date": "2024-05-22", // Not required
    "listIds": [1, 34, 11] // Not required
}

5. If you want to update a campaign you need to add the campaignId in the body:

{
    "campaignId": 12,
    "subject": "This is a test from the api",// Required
    "name": "Name of the campaign from the api", // Required
    "body": "This is the body of the email", // Not required
    "from_name": "Sender name", // Not required
    "from_email": "[email protected]", // Not required
    "reply_to_name": "No reply", // Not required
    "reply_to_email": "[email protected]", // Not required
    "bounce_email": "[email protected]", // Not required
    "bcc": "[email protected]", // Not required
    "sending_type": "now", // Default "now"
    "listIds": [1, 34, 11] // Not required
}

You can only create automatic campaign with 2 type of triggers with the API: On every cron or every X hour, day, week or month.

Send a campaign

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

Send a campaign by ID

Query Parameters

Name	Type	Description
campaignId*	String	ID of the campaign you want to send

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

200: OK Campaign successfully sent

404: Not Found Campaign not found

422: Unprocessable Entity The ID of the campaign is missing from the request

500: Internal Server Error Database error with detail

Delete a campaign

DELETE https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=api&task=deleteCampaign&campaignId={id}

Delete a campaign by ID

Query Parameters

Name	Type	Description
campaignId*	Int	The ID of the campaign 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 Campaign deleted

422: Unprocessable Entity The ID of the campaign is missing from the request

404: Not Found Campaign not found

500: Internal Server Error Database error with detail