Send Marketing or Promotional Emails
This method allows you to send or schedule bulk emails (this will also create a list from the emails passed and allows for personalization).
api_keyyour API key, available in Settings.
from_namethe 'From name' of your campaign
from_emailthe 'From email' of your campaign
reply_tothe 'Reply to' of your campaign
titlethe 'Title' of your campaign
subjectthe 'Subject' of your campaign
plain_textthe 'Plain text version' of your campaign (optional)
html_textthe 'HTML version' of your campaign (To use personlization, include tags like this e.g [Name] [Email])
emailsList of emails you want to send this campaign to. (To use personalization send emails separated with pipes, e.g 'ope | [email protected], jame | [email protected], titi | [email protected]')
brand_idRequired only if you are creating a 'Draft' campaign (
send_campaignset to 0 or left as default). Brand IDs can be found under 'Brands' page named ID
query_stringeg. Google Analytics tags (optional)
1to enable and
2for anonymous opens tracking.
1to enable and
2for anonymous clicks tracking.
1if you want to send the campaign as well and not just create a draft. Default is
ccInclude additional emails as copy. If multiple emails, make them comma separated
bccInclude additional emails as blind copy. If multiple emails, make them comma separated
schedule_date_timeCampaign will be scheduled if a valid date/time is passed. Date/time format eg. June 15, 2021 6:05pm. The minutes part of the time has to be in increments of
5, eg. 6pm, 6:05pm, 6:10pm, 6:15pm.
schedule_timezoneEg. 'America/New_York'. See the list of PHP's supported timezones. This parameter only applies if you're scheduling your campaign with
schedule_date_timeparameter. TribeArc will use your default timezone if this parameter is empty.
RESPONSE (Plain text)
Campaign created and now sending
No data passed
API key not passed
Invalid API key
From name not passed
From email not passed
Reply to email not passed
Subject not passed
HTML not passed
List or segment ID(s) not passed
Unable to create campaign
Unable to create and send campaign
Unable to schedule campaign
Unable to calculate totals
Schedule_date_time is invalid