Getting Started

This documentation is a work in progress. Please bare with us.

In order to get your api-key, please call support on [phone]

Get all the contacts

GET https://api.pakat.net/v3/contacts

Query Parameters

Name	Type	Description
limit	string	Number of documents per page
offset	string	Index of the first document of the page
modifiedSince	string	Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

Headers

Name	Type	Description
Content-Type	string	application/json
Accept	string	application/json
api-key	string	Your API Key

200 s

{
    "contacts": [
        {
            "email": "[e-mail]",
            "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": "[e-mail]",
            "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": "[e-mail]",
            "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": "[e-mail]",
            "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": "[e-mail]",
            "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": "[e-mail]",
            "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
}

Create a contact

POST https://api.pakat.net/v3/contacts

Headers

Name	Type	Description
api-key	string
Content-Type	string	application/json
Accept	string	application/json

Request Body

Name	Type	Description
smtpBlacklistSender	boolean	transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true )
updateEnabled	boolean	Facilitate to update the existing contact in the same request (updateEnabled = true)
email	string	Email address of the user. Mandatory if "sms" field is not passed in "attributes" parameter
attributes	array	Pass the set of attributes and their values. These attributes must be present in your Pakat account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'}
emailBlacklisted	boolean	Set this field to blacklist the contact for emails (emailBlacklisted = true)
smsBlacklisted	boolean	Set this field to blacklist the contact for SMS (smsBlacklisted = true)
listIds	array	Array of integers. Ids of the lists to add the contact to

200