UDT APIs

Suggest Edits

User Data Table (UDT) is the collection of contacts with additional user attributes (Eg: Email, Address) that can be then used to personalize and target campaigns. The contact details added to a user data table do not alter or impact the contact details that are available on the CEE panel contact master.

The following activities associated with UDTs can be performed using the API listed in this section:

Create: to create a user data table (UDT)
Upload: to upload user contacts to a created user data table (UDT)

Create UDT API

URL Schema:
US: http://api.netcoresmartech.com/apiv2
IN: http://apiin.netcoresmartech.com/apiv2
EU: https://jsonapi.eu-north-1.eu.netcoresmartech.com/apiv2

Method: POST
Header:

Key	Value
Content-Type	application/x-www-form-urlencoded

Parameters:

Parameter	Description	Data Type	Required	Parameter Type
type	It represents the module or group the API belongs to. For example, if the API 's functionality is related to Contacts, type is 'contact'. Value here: lists	string	Yes	Query Parameter
activity	Activity refers to the action that is being performed through the API, that is, add, delete, update, and so on. Value here: add	string	Yes	Query Parameter
apikey	You can login to your Netcore panel > Go to Profile settings > User Profile > You can find API key here.	string	Yes	Query Parameter
listname	The name of the list that you are creating.	String	Yes	Query Parameter
listtype	This refers to the type of list you want to create. Value here: udt	String	Yes	Query Parameter
udt_attr	Here you need to pass attributes present in the UDT CSV in json format as given below. UDT must have atleast one attributes besides the primary key Sample: [{"name":"EMAIL","type":"varchar"},{"name":"NAME","type":"varchar"},{"name":"DISCOUNT","type":"varchar"}]	Json	Yes	Query Parameter

Request:
Request URL:

http://api.netcoresmartech.com/apiv2?type=lists&activity=add&apikey=<api_key>&listname=<list_name>&listtype=udt&udt_attr=

Request sample for reference:

http://api.netcoresmartech.com/apiv2?type=lists&activity=add&apikey=xxxxxxxxxx&listname=APN_offer_campaign_221004&listtype=udt&udt_attr=[{"name":"EMAIL","type":"varchar"},{"name":"NAME","type":"varchar"},{"name":"DISCOUNT","type":"varchar"}]

Response: 200 OK

{
    "status": "success",
    "details": "udt added successfully",
    "id": xx
}

Upload bulk contacts to UDT API

URL Schema:
US: http://api.netcoresmartech.com/apiv2
IN: http://apiin.netcoresmartech.com/apiv2
EU: http://goapiv3.eu-north-1.eu.netcoresmartech.com/apiv2

Method: POST
Header:

Key	Value
Content-Type	application/x-www-form-urlencoded

Parameters:

Parameter	Description	Data Type	Required	Parameter Type
udtid	udtid refers to the id of the UDT (user data table) where you want to upload contacts in bulk via CSV.	string	Yes	Query Parameter
apikey	You can login to your Netcore panel > Go to Profile settings > User Profile > You can find API key here.	string	Yes	Query Parameter
type	It represents the module or group the API belongs to. For example, if the API 's functionality is related to Contacts, type is 'contact'. Value here: contact	String	Yes	Query Parameter
activity	Activity refers to the action that is being performed through the API. Value here: bulkupload	String	Yes	Query Parameter
path	Here you need to provide URL path for the CSV file that you want to upload to a specified UDT ID. Please ensure this CSV file is directly downloadable on this provided path and should end with .csv extension E.g. https://www.mydomain.com/APN_offer_campaign_221004.csv	String	Yes	Query Parameter
notifyemail	Here you can provide email id where you will be notified about the status of file upload to the specified UDT	String	Optional	Query Parameter
callback	Here you can provide URL to receive call back on successful upload of file to the specified UDT	String	Optional	Query Parameter

Request:
Request URL:

http://api.netcoresmartech.com/apiv2?udtid=<udtid>&apikey=<api_key>&type=contact&activity=bulkupload&path=<>&notifyemail=<comma seperated emails>&callback=<callback URL>

*Request sample for reference:

http://api.netcoresmartech.com/apiv2?udtid=767&apikey=xxxxxxxxxxx&type=contact&activity=bulkupload&path=https://www.mydomain.com/APN_offer_campaign_221004.csv&callback=https://mydomain.com&[email protected]

Response: 200 OK

{
    "requestid": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "result": "Success"
}

Updated 4 months ago