To use the campaign builder, follow the steps below:
From the left-hand menu, click Campaigns.
Click Campaign Builder.
Work through the sections:
Target
Create
Sender
Design
Schedule
Target
Here you can add your selection, set the campaign type and sender profile, and decide how to reach your customers by following the steps below:
The selection here is not required for the campaign setup, as the campaign will be triggered automatically with the API connection.
Set the parameters for your campaign:
Campaign type and sender profile:
This setting determines the sender from name and address, reply to name and address for your campaign when it will be sent. The other filters wouldn't apply much here as they will be disregarded later.
⚠️Important: The campaign can only have one communication channel to be eligible for API use. If multiple channels are selected, the "Used for API" checkbox will be disabled
Select only one channel type for your campaign:
Email.
SMS.
Direct Mail.
Push Notification.
Web Notification.
Custom Audience.
Custom List.
Promotion.
Click Next.
⚠️Important: Once you click Next you can't edit the choices you made on this step.
Create
In the Create screen, you can start to create your campaign:
📌Note: The campaign will be an automated campaign as it's used for API.
Enter the internal title and description of your campaign.
From the Category dropdown, select the relevant campaign category for your campaign.
Ensure Re-process my selection prior to the campaign being sent is uselected.
⚠️Important: users need to make sure they untick reprocess my selection to allow them to build custom export fields.
Sender
As you fill in the details on the Sender screen, the email preview on the right-hand side automatically updates, allowing you to see how your email will appear in a customers’ inbox.
Here you can set up:
Description: Is already populated from the Create screen.
Subject: The subject line for your email.
Preheader: This appears under the subject line. You can add more information to the subject of the email.
Add UTM codes: If you've integrated your Google Analytics account to your instance you can set UTM codes to track the performance of your campaign further across your Google Analytics account.
📌Note: A pop-up appears if you haven't added a preheader. This isn’t essential, you can either skip or add one.
Design
In the Design step, you can choose which template design you want to use for this campaign.
Click Use by the relevant template you want to use in your design.
Proceed with modifying the design of your campaign.
Save your modifications, and send an email test to yourself if required.
Once you're happy with the design, click Apply Design.
📌Note: A pop-up appears to highlight for you if all the required items are added correctly.
Verifying subject.
Verifying empty links: If your campaign design includes links that aren't well added.
Verifying personal links.
Verifying empty images.
Unsubscribe link.
View online link.
Preference link.
Saving
The statuses are:
Not added
Not added, you can skip it but it's better to add it:
Added correctly:
Schedule
Campaign details overview
In the Schedule screen, you will see an overview for the main details for your campaign:
Channel: Shows the channel you chose, email, SMS, etc.
Title: The campaign name.
Preview/Edit: To either preview or edit the campaign.
Schedule details set up
In the Schedule screen, you will have some options to add for the send of your campaign:
Start on: The date and time at which the campaign is ready to be sent.
Ends on: The date and time starting from which the campaign will no longer be sent.
Priority: Select low, normal, or high priority.
⚠️Important: A campaign marked for API use stays active indefinitely (within its start/end dates) and waits for API calls to dispatch individual communications.
Addionnal API information
Calling the API
{"CampaignID": 12345,
"ListOfRecipients": [ {
"ChannelID": 1,
"ChannelFieldValue": "[email protected]",
"CtcID": 67890,
"PersonalizedFields": [ {
"FieldName": "FirstName", "FieldValue": "John" },
{ "FieldName": "LastName", "FieldValue": "Doe" } ] } ] }
Recipient fields
Field | Required | Description |
| Yes | The channel ID from the campaign setup |
| Depends | Email address (email channel), mobile phone (SMS), or App Token (push) |
| Depends | Contact ID: mandatory for custom list/voucher channels |
| No | Member number: alternative to CtcID for push notifications |
| No | List of |
| No | When to send (null = immediately) |
API documentation
You can find all the needed API methods explained and with the possibility to test them on the sandbox instance in our API documentation guide.