Email Campaign Resources
An email campaign is a rule about when to send an email, who to send it to, and what to say in it. The content of the email comes from a content item.
Email campaigns are an experimental feature and are not available to all users.
Email Campaign Summary
- Description
- Gets a summary of the campaign
- Method
- GET
- URL
- https://api.iwannaticket.com.au/api/v2/campaign/{id}
Output
| Name | Type | Description |
|---|---|---|
| event | Ref | The event that the campaign applies to |
| eventGroup | Ref | The event group that the campaign applies to |
| eventGroupGroup | Ref | The event group group that the campaign applies to |
| name | String | The name of the campaign |
| content | Ref | The content that will be put in the email |
| closed | Boolean | Whether the campaign is closed. |
| campaignType | EmailCampaignType | The rule for determining when to fire the campaign |
| sendTime | Date | The time and date to fire the campaign. Depending on the campaignType, only some components of the send time will be used. |
| sent | Number | How many emails have successfully been sent. |
| unable | Number | How many emails are unable to be sent. |
| pending | Number | How many emails are in the process of being sent. |
| audience | EmailCampaignAudience | Rules on which users to send email to. |
Creates a new email campaign
- Method
- POST
- URL
- https://api.iwannaticket.com.au/api/v2/campaign/
Input
| Name | Type | Description |
|---|---|---|
| name | String | Campaign name |
| type | EmailCampaignType | Campaign type |
| sendTime | Date | Time and date details for when to send. |
| content | Ref | The content item to send as the email body. |
| event | Number | The ID of the event to send to. |
| eventGroup | Number | The ID of the event group to send to. |
| eventGroupGroup | Number | The ID of the event group group to send to. |
| audience | EmailCampaignAudience | Which customers to send the email to. |
Update an email campaign
- Method
- PATCH
- URL
- https://api.iwannaticket.com.au/api/v2/campaign/{id}
Input
| Name | Type | Description |
|---|---|---|
| name | optional String | Campaign name |
| type | optional EmailCampaignType | Campaign type |
| sendTime | optional Date | Time and date details for when to send. |
| closed | optional Boolean | Whether the campaign is closed or not. |
| audience | optional EmailCampaignAudience | Which customers to send the email to. |
List all email campaigns
- Method
- GET
- URL
- https://api.iwannaticket.com.au/api/v2/campaign/list
This method lists all email campaigns for the account. There is no paging option (yet).