Pakat Email Service API
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 issues please call support on +982191015383
Profile
Get your account information, plan and credits details
GET
https://api.pakat.net/v3/account
Headers
Contacts
Get all the contacts
GET
https://api.pakat.net/v3/contacts
Query Parameters
Headers
Create a contact
POST
https://api.pakat.net/v3/contacts
Example request:
{
"email":"test@pakat.net",
"updateEnabled": true,
"emailBlacklisted":false,
"listIds": [ 14 ],
"attributes": { "FIRSTNAME":"تست", "LASTNAME":"پاکت", "FIRST_PURCHASE":"12/10/2018" }
}
Headers
Request Body
Update a contact
PUT
https://api.pakat.net/v3/contacts/{email}
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
List all attributes
GET
https://api.pakat.net/v3/contacts/attributes
Headers
Get all the lists
GET
https://api.pakat.net/v3/contacts/lists
Query Parameters
Headers
Create a list
POST
https://api.pakat.net/v3/contacts/lists
Headers
Request Body
Get all folders
GET
https://api.pakat.net/v3/contacts/folders
Query Parameters
Headers
Create a folder
POST
https://api.pakat.net/v3/contacts/folders
Headers
Request Body
Transactional
Get the list of blocked or unsubscribed transactional contacts
GET
https://api.pakat.net/v3/smtp/blockedContacts
Query Parameters
Headers
Get your transactional email activity aggregated per day
GET
https://api.pakat.net/v3/smtp/statistics/reports
Query Parameters
Headers
Get your transactional email activity aggregated over a period of time
GET
https://api.pakat.net/v3/smtp/statistics/aggregatedReport
Path Parameters
Query Parameters
Headers
Get all your transactional email activity (unaggregated events)
GET
https://api.pakat.net/v3/smtp/statistics/events
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
Query Parameters
Get the list of transactional email templates
GET
https://api.pakat.net/v3/smtp/templates
Query Parameters
Create a transactional email template
POST
https://api.pakat.net/v3/smtp/templates
Path Parameters
Request Body
Returns the template informations
GET
https://api.pakat.net/v3/smtp/templates/:templateId
Path Parameters
Updates a transactional email templates
PUT
https://api.pakat.net/v3/smtp/templates/:templateId
Path Parameters
Request Body
Delete an inactive transactional email template
DELETE
https://api.pakat.net/v3/smtp/templates/:templateId
Path Parameters
Send a template to your test list
POST
https://api.pakat.net/v3/smtp/templates/templateId/sendTest
Path Parameters
Request Body
Send a transactional email
POST
https://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
Get the list of transactional emails on the basis of allowed filters
GET
https://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
GET
https://api.pakat.net/v3/emailCampaigns
Query Parameters
Create an email campaign
POST
https://api.pakat.net/v3/emailCampaigns
Request Body
Send an email campaign immediately, based on campaignId
POST
https://api.pakat.net/v3/emailCampaigns/{campaignId}/sendNow
Path Parameters
Send an email campaign to your test list
POST
https://api.pakat.net/v3/emailCampaigns/{campaignId}/sendTest
Path Parameters
Request Body
Get an email campaign report
GET
https://api.pakat.net/v3/emailCampaigns/{campaignId}
Webhooks
Get all webhooks
GET
https://api.pakat.net/v3/webhooks
Query Parameters
Create a webhook
POST
https://api.pakat.net/v3/webhooks
Request Body
Get a webhook details
GET
https://api.pakat.net/v3/webhooks/{webhookId}
Path Parameters
Update a webhook
PUT
https://api.pakat.net/v3/webhooks/{webhookId}
Path Parameters
Request Body
Delete a webhook
DELETE
https://api.pakat.net/v3/webhooks/{webhookId}
Path Parameters
Sender
Get the list of all your senders
GET
https://api.pakat.net/v3/senders
Query Parameters
Headers
Create a new sender
POST
https://api.pakat.net/v3/senders
Headers
Request Body
Example request to create a sender
Update a sender
PUT
https://api.pakat.net/v3/senders/{senderId}
Path Parameters
Headers
Request Body
Delete a sender
DELETE
https://api.sendinblue.com/v3/senders/{senderId}
Path Parameters
Headers
Last updated