Data Integration

Data Integration

If you are using only our Email and SMS channels, you will only need to integrate the master_contact table. If you are using our Mobile and Web Push channels, you will need to integrate the master_device table as well.

Sending your Contact Data to dEngage (Master Contact)

There are two options to send data to dEngage:


1. Send your data via API

BulkUpsert can be used for inserting new contacts and updating existing contacts in the master_contact table. This method takes a column list and a contactDatas array. All the data will be processed according to the columns list. Contact_key column in master_contact table is mandatory and unique across all the contacts. So, the contact_key is a mandatory parameter. You can find further documentation here.

Apart from the predefined columns in master_contact table, the users are allowed to update their custom columns in this table, provided that the column name/value pair is compatible with the table structure.

You can also use the InsertContact function for create or update a contact on master_contact table. This function to UpsertContact if updateIfExists flag set to true.

To create a new table use the CreateTable function found our API documentation.


There are two versions of UpsertData API calls, synchronous and asynchronous. This particular version is the synchronous version where no more than 1000 records rows are subject to be inserted/updated on a data table at in a single call. If you require to insert more than 1000 records at a single call, Asynchronous UpserData call must be used. The method is used to insert bulk new records or update existing ones on a data table except sys_contact table.

The method is used to insert bulk new records or update existing ones on a data table except sys_contact table.

If the target data table has primary key values, UpsertData call has to include these primary key values in input data rows as well as the rest of the to-be-updated column values.

If the target data table has no primary key values, UpsertData appends input data rows to the data table.

Input data row has to include all the column values of the target data table, otherwise an error will be returned.


2. Send your data via FTP


Please send your previously Hard Bounced, Complained or Blacklisted contacts with a flag.

You can use the email_status/gsm_status and email_permision/gsm_permission columns to specify the user permissions. 

  • email_permission/GSM_permission column's data type is boolean and default values are true. If the contact opted-out from these channels, you can set the column values as false. You can also set the values for permission columns as "false" for contacts who have complained.
  • email_status/gsm_status column's data type is character(1) and default values are "A" for Active. If the email address was previously reported as "hard bounce", you can set the email_status column's value at "P" for Passive. You can also set the values for status columns as "P" for "Blacklisted" contacts.

Sending your Token/Device data to dEngage  (Master Device)

Please follow the instructions below to send your existing Mobile and Web Push Tokens to dEngage.

1. Send your token data via FTPS


    • Related Articles

    • Event Data Integration

      There are two options to send Event Data to D·engage: 1. Send event data via D·engage SDK First, you need to create a website application to use the dEngage Web SDK. Go to D·engage Event SDK page for detailed instructions to 'create an ...

    • Neto Integration

      Neto D·engage Integration In a matter of minutes, without a single line of code you will become able to connect your Neto store to your D·engage account. This integration is a one-way sync that sends your product catalog as well as your contact and ...

    • D·engage GTM Integration

      There are two different ways for GTM integration. You can create new google tags as well as, you can use existing ones. (a) Using Existing Tags for Sending Events Data In order to use your existing triggers to send data to the D·engage platform you ...

    • Shopify Integration

      Shopify D·engage Integration In a matter of minutes, without a single line of code, you can connect your Shopify store to your D·engage account. This integration is a one-way sync that sends your product catalog as well as your contact and order data ...

    • Mixpanel - D·engage Integration

      Mixpanel is a leader in the product analytics space, that provides real-time insights into app/website interactions and leverages brands to devise effective marketing strategies according to their customer behavior. D·engage provides an ...