The API is asynchronous.

Use this Bulk Add API call if you want to add more than one contact and trigger surveys for those added where required.

When the API is used to not only add or update a contact but also send a survey to the contacts, it will apply the Global Contact rules generally but does not apply the exception for newly added contacts.

If a contact has un-subscribed from AskNicely emails, adding them again will not re-subscribe a customer.

Arguments

Use the url https://DEMO.asknice.ly/api/v1/contacts/add to post your JSON content via HTTP POST

JSON Structure

The JSON has one property called "contacts" which contains a list of your contacts.

The API requires the email as a mandatory field. In addition you can add additional data points for your contacts such as name, segment and contact specific data for each of your custom data fields e.g. "custom_field_c": "Custom Value". You can add multiple values to your custom data fields too e.g. "custom_field_c": ["Custom Value","Another Custom Value"].

Setting "obeyrules": true will trigger a survey to a contact that is eligible based on the value provided for your trigger field segment and Contact Rules on the Send page.

Limits

The API has a payload limit of 6MB.

Example Requests

Example CURL to bulk add contacts only

curl -X \
    POST https://DEMO.asknice.ly/api/v1/contacts/add \
    --header "X-apikey: " \
    --data-binary @- << JSON
{
    "contacts": [
        {
            "name": "Erwin Schrodinger",
            "email": "schrodinger@example.com"
        },
        {
            "name": "John Smith",
            "email": "john@example.com"
        }
    ]
}
JSON

Example CURL to Bulk Add contact with custom values

curl -X POST \
    https://DEMO.asknice.ly/api/v1/contacts/add \
    --header "X-apikey: " \
    --data-binary @- << JSON
{
    "contacts": [
        {
            "name": "Erwin Schrodinger",
            "email": "schrodinger@example.com",
            "custom_field_c": "Custom Value"
        },
        {
            "name": "John Smith",
            "email": "john@example.com",
            "another_custom_field_c": "Another Custom Value"
        }
    ]
}
JSON

Example CURL to Bulk Add a contact with custom fields having values

curl -X POST \
    https://DEMO.asknice.ly/api/v1/contacts/add \
    --header "X-apikey: " \
    --data-binary @- << JSON
{
    "contacts": [
        {
            "name": "Erwin Schrodinger",
            "email": "schrodinger@example.com",
            "custom_field_c": [
                "Custom Value",
                "Another Custom Value"
            ]
        }
    ]
}
JSON

Example CURL to bulk add/update contacts & trigger a survey

curl -X POST \
    https://DEMO.asknice.ly/api/v1/contacts/add \
    --header "X-apikey: " \
    --data-binary @- << JSON
{
    "contacts": [
        {
            "name": "Erwin Schrodinger",
            "email": "schrodinger@example.com",
            "obeyrules": true
        },
        {
            "name": "John Smith",
            "email": "john@example.com",
            "obeyrules": true
        }
    ]
}
JSON
    

Responses

{
  "success": true
}

{
  "success": false,
  "msg": "no data found",
}

{
  "success": false,
  "msg": "Errors found in json - {error}",
}

{
  "success": false,
  "msg": "if set, contacts must be an array",
}

{
  "success": false,
  "msg": "Internal Server Error",
}