This documentation is a work in progress.
In order to get your api-key, please click on Login and get your api-key in profile
.If you have any issue please call support on +982128423221
{"contacts": [{"email": "hadi@google.com","id": 7,"emailBlacklisted": false,"smsBlacklisted": false,"createdAt": "2019-07-22T07:39:18.409+01:00","modifiedAt": "2019-07-22T07:42:34.627+01:00","listIds": [],"attributes": {"LASTNAME": "Hadi","FIRSTNAME": "Farnoud","SMS": "09203016490"}},{"email": "saeedjoshani@gmail.com","id": 6,"emailBlacklisted": false,"smsBlacklisted": false,"createdAt": "2019-07-22T06:49:48.549+01:00","modifiedAt": "2019-07-22T06:49:48.582+01:00","listIds": [4],"attributes": {}},{"email": "hadi@kamva.ir","id": 5,"emailBlacklisted": false,"smsBlacklisted": false,"createdAt": "2019-07-10T14:48:25.134+01:00","modifiedAt": "2019-07-10T14:48:25.134+01:00","listIds": [2],"attributes": {}},{"email": "dev-email@flywheel.local","id": 4,"emailBlacklisted": false,"smsBlacklisted": false,"createdAt": "2019-07-10T14:48:25.092+01:00","modifiedAt": "2019-07-10T14:48:25.092+01:00","listIds": [2],"attributes": {}},{"email": "hadi.farnoud@gmail.com","id": 2,"emailBlacklisted": false,"smsBlacklisted": false,"createdAt": "2019-07-07T11:48:19.000+01:00","modifiedAt": "2019-07-07T11:48:19.658+01:00","listIds": [2],"attributes": {}},{"email": "test@kamva.ir","id": 1,"emailBlacklisted": false,"smsBlacklisted": false,"createdAt": "2019-06-15T11:13:41.443+01:00","modifiedAt": "2019-07-29T09:31:08.495+01:00","listIds": [2],"attributes": {}}],"count": 6}
{
"email":"test@pakat.net",
"updateEnabled": true,
"emailBlacklisted":false,
"listIds": [ 14 ],
"attributes": { "FIRSTNAME":"تست", "LASTNAME":"پاکت", "FIRST_PURCHASE":"12/10/2018" }
}
Contact updated
integer
Count of blocked or unsubscribed contact
contacts object
contacts[].email string
Email address of the blocked or unsubscribed contact
contacts[].senderEmail string
Sender email address of the blocked or unsubscribed contact
contacts[].reason object
Reason for blocking / unsubscribing
contacts[].reason.code string
Reason code for blocking / unsubscribing (This code is safe for comparison)
contacts[].reason.message string
Reason for blocking / unsubscribing (This string is not safe for comparison){"contacts":[0:{"email":"abc@xyz.com""senderEmail":"ez312@gmal.com""reason":{"message":"Admin blocked""code":"adminBlocked"}"blockedAt":"2017-05-01T12:30:00Z"}]"count":1}
{"reports":[0:{"date":"2017-04-30""requests":10756"delivered":10103"hardBounces":21"softBounces":137"clicks":1026"uniqueClicks":720"opens":5091"uniqueOpens":2318"spamReports":0"blocked":519"invalid":1"unsubscribed":0}1:{"date":"2017-05-01""requests":18812"delivered":17499"hardBounces":34"softBounces":254"clicks":1514"uniqueClicks":1090"opens":10089"uniqueOpens":4393"spamReports":0"blocked":920"invalid":2"unsubscribed":3}]}
{"range":"2016-09-08|2017-04-28""requests":19887"delivered":18996"hardBounces":234"softBounces":1533"clicks":9987"uniqueClicks":8766"opens":17654"uniqueOpens":13688"spamReports":1"blocked":2"invalid":0"unsubscribed":2}
{"events":[0:{"email":"john.smith@example.com""date":"2017-03-12T12:30:00Z""messageId":"<201798300811.5787683@example.domain.com>""event":"deferred""reason":"Error connection timeout""tag":"OrderConfirmation""from":"john@example.com"}1:{"email":"john.smith@example.com""date":"2017-03-13T16:30:00Z""messageId":"<201798300811.5787683@example.domain.com>""event":"delivered""tag":"OrderConfirmation""from":"john@example.com"}]}
{"count":2"templates":[0:{"id":5"name":"ChristomasTimeTemplate""subject":"Merry Christmas""isActive":false"testSent":false"sender":{...}"replyTo":"replyto@domain.com""toField":"""tag":"Festival""htmlContent":"HTML CONTENT 1""createdAt":"2016-02-24T14:44:24Z""modifiedAt":"2016-02-24T15:37:11Z"}1:{"id":12"name":"SummerSales2017Template""subject":"Enjoy our summer Sales !""isActive":true"testSent":false"sender":{...}"replyTo":"replyto@domain.com""toField":"""tag":"Summer""htmlContent":"HTML CONTENT 2""createdAt":"2016-02-25T11:53:26Z""modifiedAt":"2016-02-25T11:53:26Z"}]}
{"name":"xyz", "email":"example@abc.com"}
, {"name":"xyz", "id":123}
{"id":33"name":"OrderConfirmation""subject":"Order Confirmation : Thanks for your Purchase !""isActive":true"testSent":false"sender":{"name":"John""email":"john.smith@example.com""id":26}"replyTo":"replyto@domain.com""toField":"""tag":"""htmlContent":"HTML CONTENT 4""createdAt":"2016-02-25T11:53:26Z""modifiedAt":"2016-02-25T11:53:26Z"}
{"name":"xyz", "email":"example@abc.com", id="3" }
transactional email template updated
bad request
Template ID not found
Inactive transactional email template has been deleted
Test email has been sent successfully to all recipients
string
Name of the sender from which the emails will be sent. Maximum allowed characters are 70.
email* string
Email of the sender from which the emails will be sent (required)string
Email address in reply to (required)
name string
Name in reply to. Maximum allowed characters are 70[{"url":"https://attachment.domain.com/myAttachmentFromUrl.jpg", "name":"My attachment 1"}, {"content":"base64 exmaple content", "name":"My attachment 2"}]
. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then only attachment url is accepted. If template is in Old template Language format, then 'attachment' is ignored ){"sender.ip":"1.2.3.4", "X-Mailin-custom":"some_custom_header"}
.string
: Message ID of the transactional email senttransactional email sent
[Object] campaignsInteger campaigns[].idID of the campaignString campaigns[].nameName of the campaignString campaigns[].subjectSubject of the campaign. Only available if abTesting flag of the campaign is falseString campaigns[].typeType of campaignString campaigns[].statusStatus of the campaignString campaigns[].scheduledAtUTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ)Boolean campaigns[].abTestingStatus of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled.String campaigns[].subjectASubject A of the ab-test campaign. Only available if abTesting flag of the campaign is trueString campaigns[].subjectBSubject B of the ab-test campaign. Only available if abTesting flag of the campaign is trueInteger campaigns[].splitRuleThe size of your ab-test groups. Only available if abTesting flag of the campaign is trueString campaigns[].winnerCriteriaCriteria for the winning version. Only available if abTesting flag of the campaign is trueInteger campaigns[].winnerDelayThe duration of the test in hours at the end of which the winning version will be sent. Only available if abTesting flag of the campaign is trueBoolean campaigns[].sendAtBestTimeIt is true if you have chosen to send your campaign at best time, otherwise it is falseBoolean campaigns[].testSentRetrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent)String campaigns[].headerHeader of the campaignString campaigns[].footerFooter of the campaignObject campaigns[].senderString campaigns[].sender.nameSender name of the campaignString campaigns[].sender.emailSender email of the campaignString campaigns[].sender.idSender id of the campaignString campaigns[].replyToEmail defined as the "Reply to" of the campaignString campaigns[].toFieldCustomisation of the "to" field of the campaignString campaigns[].htmlContentHTML content of the campaignString campaigns[].shareLinkLink to share the campaign on social mediasString campaigns[].tagTag of the campaignString campaigns[].createdAtCreation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)String campaigns[].modifiedAtUTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)Boolean campaigns[].inlineImageActivationStatus of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email.Boolean campaigns[].mirrorActiveStatus of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaignBoolean campaigns[].recurringFOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several timesString campaigns[].sentDateSent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent'Integer campaigns[].returnBounceTotal number of non-delivered campaigns for a particular campaign id.Object campaigns[].recipients[Integer] campaigns[].recipients.lists[Integer] campaigns[].recipients.exclusionListsObject campaigns[].statisticsObject campaigns[].statistics.globalStatsOverall statistics of the campaign[Object] campaigns[].statistics.campaignStatsList-wise statistics of the campaign.Integer campaigns[].statistics.mirrorClickNumber of clicks on mirror linkInteger campaigns[].statistics.remainingNumber of remaning emails to sendObject campaigns[].statistics.linksStatsStatistics about the number of clicks for the linksObject campaigns[].statistics.statsByDomainObject campaigns[].statistics.statsByDeviceObject campaigns[].statistics.statsByBrowserString campaigns[].shareLinkLink to share the campaign on social mediasInteger countNumber of Email campaigns retrieved
winnerCriteria
is ignored if passedwinnerDelay
is ignored if passedEmail campaigns informationsResponse schema type: object