Pakat Email Service API

{
    "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
}

​

Contact updated

{
"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"
}
]
}

​

{
"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"
}

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

transactional email sent

​

[Object]	campaigns
Integer	campaigns[].id
ID of the campaign
​
String	campaigns[].name
Name of the campaign
​
String	campaigns[].subject
Subject of the campaign. Only available if abTesting flag of the campaign is false
​
String	campaigns[].type
Type of campaign
​
String	campaigns[].status
Status of the campaign
​
String	campaigns[].scheduledAt
UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ)
​
Boolean	campaigns[].abTesting
Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled.
​
String	campaigns[].subjectA
Subject A of the ab-test campaign. Only available if abTesting flag of the campaign is true
​
String	campaigns[].subjectB
Subject B of the ab-test campaign. Only available if abTesting flag of the campaign is true
​
Integer	campaigns[].splitRule
The size of your ab-test groups. Only available if abTesting flag of the campaign is true
​
String	campaigns[].winnerCriteria
Criteria for the winning version. Only available if abTesting flag of the campaign is true
​
Integer	campaigns[].winnerDelay
The 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 true
​
Boolean	campaigns[].sendAtBestTime
It is true if you have chosen to send your campaign at best time, otherwise it is false
​
Boolean	campaigns[].testSent
Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent)
​
String	campaigns[].header
Header of the campaign
​
String	campaigns[].footer
Footer of the campaign
​
Object	campaigns[].sender
String	campaigns[].sender.name
Sender name of the campaign
​
String	campaigns[].sender.email
Sender email of the campaign
​
String	campaigns[].sender.id
Sender id of the campaign
​
String	campaigns[].replyTo
Email defined as the "Reply to" of the campaign
​
String	campaigns[].toField
Customisation of the "to" field of the campaign
​
String	campaigns[].htmlContent
HTML content of the campaign
​
String	campaigns[].shareLink
Link to share the campaign on social medias
​
String	campaigns[].tag
Tag of the campaign
​
String	campaigns[].createdAt
Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
​
String	campaigns[].modifiedAt
UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
​
Boolean	campaigns[].inlineImageActivation
Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email.
​
Boolean	campaigns[].mirrorActive
Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign
​
Boolean	campaigns[].recurring
FOR 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 times
​
String	campaigns[].sentDate
Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent'
​
Integer	campaigns[].returnBounce
Total number of non-delivered campaigns for a particular campaign id.
​
Object	campaigns[].recipients
[Integer]	campaigns[].recipients.lists
[Integer]	campaigns[].recipients.exclusionLists
Object	campaigns[].statistics
Object	campaigns[].statistics.globalStats
Overall statistics of the campaign
​
[Object]	campaigns[].statistics.campaignStats
List-wise statistics of the campaign.
​
Integer	campaigns[].statistics.mirrorClick
Number of clicks on mirror link
​
Integer	campaigns[].statistics.remaining
Number of remaning emails to send
​
Object	campaigns[].statistics.linksStats
Statistics about the number of clicks for the links
​
Object	campaigns[].statistics.statsByDomain
Object	campaigns[].statistics.statsByDevice
Object	campaigns[].statistics.statsByBrowser
String	campaigns[].shareLink
Link to share the campaign on social medias
​
Integer	count
Number of Email campaigns retrieved

Email campaigns informations
​
Response schema type: object
​