TribeArc Mail's API is based on simple HTTP POST. Use the API to integrate TribeArc programmatically with your website or application.
This method adds a new subscriber to a list. You can also use this method to update an existing subscriber. On another note, you can also embed a subscribe form on your website using TribeArc's subscribe form HTML code. Visit View all lists, select your desired list then click 'Subscribe form' at the top of the page.
URL
https://mail.tribearc.com/subscribe
PARAMETERS (POST)
Note: You can also pass values into custom fields or update them. To do so, use the personalization tag of the custom field as the parameter. Say, your custom field tag is [Birthday,fallback=], you can use the parameter, 'Birthday' to add values to this custom field or update it.
api_key your API key, available in Settings.name user's name (optional)email user's emaillist the list id you want to subscribe a user to. This encrypted & hashed id can be found under View all lists section named ID.country user's 2 letter country code (optional)ipaddress user's IP address (optional)referrer the URL where the user signed up from (optional)gdpr if you're signing up EU users in a GDPR compliant manner, set this to "true" (optional)silent set to "true" if your list is 'Double opt-in' but you want to bypass that and signup the user to the list as 'Single Opt-in instead' (optional)hp include this 'honeypot' field to prevent spambots from signing up via this API call. When spambots fills in this field, this API call will exit, preventing them from signing up fake addresses to your form. This parameter is only supported in TribeArc 3.0 onwards. (optional)boolean set this to "true" so that you'll get a plain text response (optional)RESPONSE (Plain text)
Success: true
Error: Some fields are missing.
Error: API key not passed
Error: Invalid API key
Error: Invalid email address.
Error: Already subscribed.
Error: Bounced email address.
Error: Email is suppressed.
Error: Invalid list ID.
This method allows the api user to subscribe multiple users to a list.
URL
https://mail.tribearc.com/subscribers/subscribe-bulk.php
PARAMETERS (POST)
api_key your API KEY, available in Settings.list the list id you want to unsubscribe a user from. This encrypted & hashed id can be found under View all lists section named IDsubscribers list of name and email (Firstname Lastname, [email protected]) of the subscribers to add to the list. Add name and email per line in your textrea RESPONSE (json)
Success: {status : true, message : "Subscriber(s) added successfully", list : list_id}
Error: Some fields are missing.
Error: API Key not passed.
Error: List id not passed.
Error: Invalid list id or api_key.
Error: Subscribers list not passed.
This method unsubscribes a user from a list.
URL
https://mail.tribearc.com/unsubscribe.php
PARAMETERS (POST)
email user's emaillist the list id you want to unsubscribe a user from. This encrypted & hashed id can be found under View all lists section named IDboolean set this to "true" so that you'll get a plain text responseRESPONSE (Plain text)
Success: true
Error: Some fields are missing.
Error: Invalid email address.
Error: Email does not exist.
This method unsubscribes multiple users from a list.
URL
https://mail.tribearc.com/subscribers/unsubscribe.php?action=bulk
PARAMETERS (POST)
api_key your API KEY, available in Settings.list_id the list id you want to unsubscribe a user from. This encrypted & hashed id can be found under View all lists section named IDemails each email must be seperated with comma (,)
[email protected], [email protected]
RESPONSE (Plain text)
Success: true
Error: Invalid api key.
Error: No data passed.
Error: List ID not passed.
Error: Email list not passed.
This method deletes a subscriber off a list (only supported in TribeArc version 2.1.1.4 and above).
URL
https://mail.tribearc.com/api/subscribers/delete.php
PARAMETERS (POST)
api_key your API key, available in Settings.list_id the id of the list you want to delete the subscriber from. This encrypted id can be found under View all lists section named IDemail the email address you want to deleteRESPONSE (Plain text)
Success: true
Error: No data passed
Error: API key not passed
Error: Invalid API key
Error: List ID not passed
Error: List does not exist
Error: Email address not passed
Error: Subscriber does not exist
This method gets the current status of a subscriber (eg. subscribed, unsubscribed, bounced, complained).
URL
https://mail.tribearc.com/api/subscribers/subscription-status.php
PARAMETERS (POST)
api_key your API key, available in Settings.email user's emaillist_id the id of the list this email belongs to. This encrypted id can be found under View all lists section named IDRESPONSE (Plain text)
Success: Subscribed
Success: Unsubscribed
Success: Unconfirmed
Success: Bounced
Success: Soft bounced
Success: Complained
Error: No data passed
Error: API key not passed
Error: Invalid API key
Error: Email not passed
Error: List ID not passed
Error: Email does not exist in list
This method gets the current status of multiple subscribers (eg. subscribed, unsubscribed, bounced, complained).
URL
https://mail.tribearc.com/api/subscribers/subscription-status.php?action=bulk
PARAMETERS (POST)
api_key your API key, available in Settings.emails users' email Seperate each email address with comma (,)list_id the id of the list this email belongs to. This encrypted id can be found under View all lists section named IDRESPONSE (JSON)
Success: {status : true, email : [email protected], subscription_status : "subscribed"}
Error: {status : false, message : "No data passed"
Error: {status : false, message : "API key not passed"
Error: {status : false, message : "Invalid API key"
Error: {status : false, message : "List ID not passed"
Error: {status : false, message : "Emails not passed"
This method gets the total active subscriber count of a list.
URL
https://mail.tribearc.com/api/subscribers/active-subscriber-count.php
PARAMETERS (POST)
api_key your API key, available in Settings.list_id the id of the list you want to get the active subscriber count. This encrypted id can be found under View all lists section named IDRESPONSE (Plain text)
Success: You'll get an integer of the active subscriber count
Error: No data passed
Error: API key not passed
Error: Invalid API key
Error: List ID not passed
Error: List does not exist
This method gets all list of a particular user using the api key.
URL
https://mail.tribearc.com/api/lists/
PARAMETERS (POST)
api_key your API key, available in Settings.RESPONSE (JSON)
Success:
{
status : true,
message : "success",
lists : [array of lists with subscribers]},
Error: {"status": false, "message": "API key not passed"}
Error: {"status": false, "message": "Account not found"}
This method is used to create a list.
URL
https://mail.tribearc.com/api/lists/create-list.php
PARAMETERS (POST)
api_key your API key, available in Settings.name Name of the list.opt_in Optional. value can be 1 or 0RESPONSE (JSON)
Success:
{
status : true,
message : "List added successfully",
list_id : new_list_id}
Error: {"status": false, "message": "API key not passed"}
Error: {"status": false, "message": "Invalid API Key"}
Error: {"status": false, "message": "List name not passed"}
This method is used to delete a list.
URL
https://mail.tribearc.com/api/lists/delete.php
PARAMETERS (POST)
api_key your API key, available in Settings.name Name of the list.opt_in Optional. value can be 1 or 0RESPONSE (Plain text)
Success: true
Error: List id not passed
Error: Api_key not passed
Error: Invalid API Key
Error: Invalid list id or api_key
This method return array of subscribers grouped by their status.
URL
https://mail.tribearc.com/api/lists/get-subscribers.php
PARAMETERS (POST)
api_key your API key, available in Settings.list_id the id of the list you want to get al the subscribers. This encrypted id can be found under View all lists section named IDRESPONSE (Json)
Success: {status : true, message : "success", subscribers : {all : [], confirmed : [], unsubscribed : [], bounced : [], gdpr: [],} }
Error: {status : false, message : "Api_key not passed"}
Error: {status : false, message : "Invalid API Key"}
Error: {status : false, message : "List id not passed"}
Error: {status : false, message : "Invalid list id or api_key"}
This method allows you to create, send or schedule a campaign.
URL
https://mail.tribearc.com/api/campaigns/create.php
PARAMETERS (POST)
api_key your API key, available in Settings.from_name the 'From name' of your campaignfrom_email the 'From email' of your campaignreply_to the 'Reply to' of your campaigntitle the 'Title' of your campaignsubject the 'Subject' of your campaignplain_text the 'Plain text version' of your campaign (optional)html_text the 'HTML version' of your campaignlist_ids Required only if you set send_campaign to 1 and no segment_ids are passed in. List IDs should be single or comma-separated. The encrypted & hashed ids can be found under View all lists section named ID.segment_ids Required only if you set send_campaign to 1 and no list_ids are passed in. Segment IDs should be single or comma-separated. Segment ids can be found in the segments setup page.exclude_list_ids Lists to exclude from your campaign. List IDs should be single or comma-separated. The encrypted & hashed ids can be found under View all lists section named ID. (optional)exclude_segments_ids Segments to exclude from your campaign. Segment IDs should be single or comma-separated. Segment ids can be found in the segments setup page. (optional)brand_id Required only if you are creating a 'Draft' campaign (send_campaign set to 0 or left as default). Brand IDs can be found under 'Brands' page named IDquery_string eg. Google Analytics tags (optional)track_opens Set to 0 to disable, 1 to enable and 2 for anonymous opens tracking.track_clicks Set to 0 to disable, 1 to enable and 2 for anonymous clicks tracking.send_campaign Set to 1 if you want to send the campaign as well and not just create a draft. Default is 0.schedule_date_time Campaign 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_timezone Eg. 'America/New_York'. See the list of PHP's supported timezones. This parameter only applies if you're scheduling your campaign with schedule_date_time parameter. TribeArc will use your default timezone if this parameter is empty.RESPONSE (Plain text)
Success: Campaign created
Success: Campaign created and now sending
Success: Campaign scheduled
Error: No data passed
Error: API key not passed
Error: Invalid API key
Error: From name not passed
Error: From email not passed
Error: Reply to email not passed
Error: Subject not passed
Error: HTML not passed
Error: List or segment ID(s) not passed
Error: One or more list IDs are invalid
Error: One or more segment IDs are invalid
Error: List or segment IDs does not belong to a single brand
Error: Brand ID not passed
Error: Unable to create campaign
Error: Unable to create and send campaign
Error: Unable to schedule campaign
Error: Unable to calculate totals
This method allows you to send or schedule bulk emails (this will also create a list from the emails passed and allows for personalization).
URL
https://mail.tribearc.com/api/campaigns/send_email.php
PARAMETERS (POST)
api_key your API key, available in Settings.from_name the 'From name' of your campaignfrom_email the 'From email' of your campaignreply_to the 'Reply to' of your campaigntitle the 'Title' of your campaignsubject the 'Subject' of your campaignplain_text the 'Plain text version' of your campaign (optional)html_text the 'HTML version' of your campaign (To use personlization, include tags like this e.g [Name] [Email])emails List 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_id Required only if you are creating a 'Draft' campaign (send_campaign set to 0 or left as default). Brand IDs can be found under 'Brands' page named IDquery_string eg. Google Analytics tags (optional)track_opens Set to 0 to disable, 1 to enable and 2 for anonymous opens tracking.track_clicks Set to 0 to disable, 1 to enable and 2 for anonymous clicks tracking.send_campaign Set to 1 if you want to send the campaign as well and not just create a draft. Default is 0.cc Include additional emails as copy. If multiple emails, make them comma separatedbcc Include additional emails as blind copy. If multiple emails, make them comma separatedschedule_date_time Campaign 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_timezone Eg. 'America/New_York'. See the list of PHP's supported timezones. This parameter only applies if you're scheduling your campaign with schedule_date_time parameter. TribeArc will use your default timezone if this parameter is empty.RESPONSE (Plain text)
Success: Campaign created
Success: Campaign created and now sending
Success: Campaign scheduled
Error: No data passed
Error: API key not passed
Error: Invalid API key
Error: From name not passed
Error: From email not passed
Error: Reply to email not passed
Error: Subject not passed
Error: HTML not passed
Error: List or segment ID(s) not passed
Error: Unable to create campaign
Error: Unable to create and send campaign
Error: Unable to schedule campaign
Error: Unable to calculate totals
Error: Schedule_date_time is invalid
This method allows you to send mail immediately to one recipient. Useful for OTP, verification mails etc.
URL
https://mail.tribearc.com/api/campaigns/send_now.php
PARAMETERS (POST)
api_key your API key, available in Settings.from_name the 'From name' of your campaign (optional)from_email the 'From email' of your campaign (optional)reply_to the 'Reply to' of your campaign (optional)subject the 'Subject' of your campaign (optional)plain_text the 'Plain text version' of your campaign (optional)html_text the 'HTML version' of your campaignemails A single email you want to send to. (Only one recipient email is expected) (optional)send_campaign Set to 1 if you want to send the campaign as well and not just create a draft. Default is 0.brand_id Required only if you are creating a 'Draft' campaign (send_campaign set to 0 or left as default). Brand IDs can be found under 'Brands' page named IDquery_string eg. Google Analytics tags (optional)track_opens Set to 0 to disable, 1 to enable and 2 for anonymous opens tracking.track_clicks Set to 0 to disable, 1 to enable and 2 for anonymous clicks tracking.cc Include additional emails as copy. If multiple emails, make them comma separatedbcc Include additional emails as blind copy. If multiple emails, make them comma separatedschedule_date_time Campaign 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_timezone Eg. 'America/New_York'. See the list of PHP's supported timezones. This parameter only applies if you're scheduling your campaign with schedule_date_time parameter. TribeArc will use your default timezone if this parameter is empty.attachments (Optional parameter) to attach files to your CampaignRESPONSE (Plain text)
Success: Campaign created
Success: Campaign created and now sending
Success: Campaign scheduled
Error: No data passed
Error: API key not passed
Error: Invalid API key
Error: From name not passed
Error: From email not passed
Error: Reply to email not passed
Error: Subject not passed
Error: HTML not passed
Error: List or segment ID(s) not passed
Error: Unable to create campaign
Error: Unable to create and send campaign
Error: Unable to schedule campaign
Error: Unable to calculate totals
Error: Schedule_date_time is invalid
This method allows you to send sms to DND numbers instantly. Useful for OTP, verification codes etc.
URL
https://mail.tribearc.com/api/sms/send_now.php
PARAMETERS (POST)
api_key your API key, available in Settings.from the Company's name (We Show 'MAlert' by default because of DND). You should include your company's name in the message body instead.to the recipient's telephone numbermessage The actual message you intend to send. Include your company name at the beginnnig or end of your message. (Max lenght is 159)RESPONSE (Plain text)
Success: Message Successful
Error: No data passed
Error: API key not passed
Error: Invalid API key
Error: From name not passed
Error: To Phone number not passed
Error: Message is empty
Error: Phone number must be between 11 to 14 digits long, use international format (+23470345xxxxx)
Error: Message too long. Max of 159 characters
This method allows you to get sms units left.
URL
https://mail.tribearc.com/api/sms/get_balance.php
PARAMETERS (POST)
api_key your API key, available in Settings.RESPONSE (Plain text)
Success: Message Successful
Error: API key not passed
Error: Invalid API key
This method get the status of user (API_KEY) from_email status. The response of this endpoint can be any of pending, verify or unverified.
URL
https://mail.tribearc.com/api/identity/status.php
PARAMETERS (POST)
api_key your API key, available in Settings.from_email campaign from_emailRESPONSE (Plain text)
Success: from_email_status
Error: No data passed
Error: API key not passed
Error: Invalid API key
Error: from_email not passed
This method verify the Campaign's from_email.
URL
PARAMETERS (POST)
api_key your API key, available in Settings.from_email campaign from_email
https://mail.tribearc.com/api/emails/verify.php