Follow Up
Create a new follow up
POST
https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=createOrUpdateFollowUp
This endpoint allows you to create or update an existing follow up
Headers
Name | Value |
---|---|
Content-Type |
|
Api-Key | The API key of a valid AcyMailing license used in the AcyMailing configuration page, tab "License". |
Body
Name | Type | Description |
---|---|---|
| string | Name of the user |
| string | The name displayed in the front end when a user is on the unsubscribe page |
| string | When a follow up will be triggered, it should be one of these value: - user_subscribe: When a user subscribe - birthday: On user birthday - user_creation: On user creation - woocommerce_purchase: When a user purchase a product on WooCommerce - hikashop_purchase: When a user purchase a product on WooCommerce |
| array | This option is not required, if you want to add condition on the trigger: |
| integer | 1 or 0 if you want to loop the follow-up, this means that when sending the last follow-up email to a subscriber, the follow-up can be re-trigger and all emails are sent again to this subscriber |
| integer | You need to specify the amount of seconds. If you want to loop you can add a delay before the follow-up is re-triggered, for example you send your first email 1 day after the trigger, if you add a delay of 2 days, the first email will be sent 3 days after the last email of the follow-up |
| array | Array of mail ID to skip when the follow-up is looping |
Example of Body
Response
Attach an email to a follow up
POST
https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=attachEmailToFollowUp
This endpoint allows you to create and attach an email to a follow up. You can also update an existing email attached to a follow up.
Headers
Name | Value |
---|---|
Content-Type |
|
Api-Key | The API key of a valid AcyMailing license used in the AcyMailing configuration page, tab "License". |
Body
Name | Type | Description |
---|---|---|
| number | The ID of the follow up you want to attach an email to |
| number | The delay of the email in the follow-up |
| number | The unit of the delay, its value should be one of these: - minutes - hours - days - weeks - months |
| array | The email to send, here is the structure: |
Example of body
Response
Delete an email from a follow up
DELETE
https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=deleteEmailFromFollowUp
This endpoint allows you to delete an emails from a follow up
Headers
Name | Value |
---|---|
Content-Type |
|
Api-Key | The API key of a valid AcyMailing license used in the AcyMailing configuration page, tab "License". |
Query
Name | Type | Description |
---|---|---|
| number | ID of the follow up |
| number | ID of the email |
Example of query
https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=deleteEmailFromFollowUp&followUpId=3&mailId=43
Response
Delete a follow up
DELETE
https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=deleteFollowUp
This endpoint allows you to delete a follow up
Headers
Name | Value |
---|---|
Content-Type |
|
Api-Key | The API key of a valid AcyMailing license used in the AcyMailing configuration page, tab "License". |
Query
Name | Type | Description |
---|---|---|
| number | ID of the follow up to delete |
Example of query
https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=deleteFollowUp&followUpId=3
Response
Get all follow ups
GET
https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=getFollowUps
This endpoint allows you to get all the follow ups
Headers
Name | Value |
---|---|
Content-Type |
|
Api-Key | The API key of a valid AcyMailing license used in the AcyMailing configuration page, tab "License". |
Query
Name | Type | Description |
---|---|---|
| number | The start of the followup you want to be returned from the database, by default it's value is 0 |
| number | The number of follow up returned, by default it's 100 |
| array | You can filters follow up by column value: |
Example of Query
Query to get follow ups with test in the name
https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=getFollowUps&filter[name]=test
Query to get 3 follow ups with the trigger birthday
https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=getFollowUps&filter[trigger]=birthday&limit=3
Response
Get one follow up by ID
GET
https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=getFollowUpById
This endpoint allows you to get a specific follow up
Headers
Name | Value |
---|---|
Content-Type |
|
Api-Key | The API key of a valid AcyMailing license used in the AcyMailing configuration page, tab "License". |
Query
Name | Type | Description |
---|---|---|
| number | The ID of the follow up to get |
Example of Query
https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=getFollowUpById&followUpId=1
Response
Last updated