Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For eg. { 'EMAIL':'newemail@domain.com', 'FNAME':'Hadi', 'LNAME':'Mofidi'}
Path Parameters
Headers
Request Body
Contact updated
List all attributes
GEThttps://api.pakat.net/v3/contacts/attributes
Headers
Get all the lists
GEThttps://api.pakat.net/v3/contacts/lists
Query Parameters
Headers
Create a list
POSThttps://api.pakat.net/v3/contacts/lists
Headers
Request Body
Get all folders
GEThttps://api.pakat.net/v3/contacts/folders
Query Parameters
Headers
Create a folder
POSThttps://api.pakat.net/v3/contacts/folders
Headers
Request Body
Transactional
Get the list of blocked or unsubscribed transactional contacts
GEThttps://api.pakat.net/v3/smtp/blockedContacts
Query Parameters
Headers
Get your transactional email activity aggregated per day
This endpoint will show the aggregated stats for past 30 days by default if startDate and endDate OR days is not passed. The date range can not exceed 90 days
Test email has been sent successfully to all recipients
Send a transactional email
POSThttps://api.pakat.net/v3/smtp/email
In order to insert data in a transactional template you have two options
1: contact attributes
contact attributes defined in Contasts can be used as {{ contacts.FIRSTNAME }}in your template and you do not have to pass anything in API call. if the to field exists in a Contacts list, the data will be retrieved from there.
2: api params
you can pass parameters when using this API. use {{ params.FNAME }} for example in your template in order to accept FNAME parameter from API request.
Headers
Request Body
transactional email sent
Get the list of transactional emails on the basis of allowed filters
GEThttps://api.pakat.net/v3/smtp/emails
This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.
Request Body
Email Campaigns
Return all your created email campaigns
GEThttps://api.pakat.net/v3/emailCampaigns
Query Parameters
[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