Data Map
Overview
The Data Map endpoint allows you to manage your Data Maps, by creating new Data Maps, or by requesting information about or updating existing Data Maps.
Endpoint (North America): https://api.eccmp.com/services2/api/DataMap
Endpoint (Europe): https://api.ccmp.eu/services2/api/DataMap
Endpoint (Japan): https://api.marketingsuite.jp/services2/api/DataMap
For more details on how to set up a Data Map API request, please see the Data Map API Technical Guide.
GET Method
The Data Map endpoint supports the following GET operation. This endpoint allows you to retrieve information about a specified Data Map by providing its Object Reference ID.
Click hereClick here to see a sample response message in JSON format.
{
"prop_map_id": 3451,
"prop_map_name": "Test data map",
"entity_id": 100,
"cust_id": 123,
"propMapImportSetting": {
"prop_map_id": 3451,
"suppress_new_flag": 0,
"suppress_old_flag": 0
},
"propMapFlat": {
"prop_map_id": 3451,
"first_row": 2,
"separator": "\\t"
},
"propMapProps": [
{
"prop_map_id": 3451,
"prop_id": 1150,
"seq": 1,
"label": "email",
"propMapPropImportSetting": {
"prop_map_id": 3451,
"prop_id": 1150,
"blast_flag": 0,
"keep_old_value_flag": 0,
"treat_null_as_value_flag": 0,
"case_sensitive_flag": 0,
"multivalue_append_flag": 0,
"skip_email_ban_flag": 0
}
},
{
"prop_map_id": 3451,
"prop_id": 1100,
"seq": 2,
"label": "name_first",
"propMapPropImportSetting": {
"prop_map_id": 3451,
"prop_id": 1100,
"blast_flag": 0,
"keep_old_value_flag": 0,
"treat_null_as_value_flag": 0,
"case_sensitive_flag": 0,
"multivalue_append_flag": 0,
"skip_email_ban_flag": 0
}
},
{
"prop_map_id": 3451,
"prop_id": 1320,
"seq": 3,
"label": "business_phone",
"propMapPropImportSetting": {
"prop_map_id": 3451,
"prop_id": 1320,
"blast_flag": 0,
"keep_old_value_flag": 0,
"treat_null_as_value_flag": 0,
"case_sensitive_flag": 0,
"multivalue_append_flag": 0,
"skip_email_ban_flag": 0
}
},
{
"prop_map_id": 3451,
"prop_id": 1240,
"seq": 4,
"label": "home_phone",
"propMapPropImportSetting": {
"prop_map_id": 3451,
"prop_id": 1240,
"blast_flag": 0,
"keep_old_value_flag": 0,
"treat_null_as_value_flag": 0,
"case_sensitive_flag": 0,
"multivalue_append_flag": 0,
"skip_email_ban_flag": 0
}
},
{
"prop_map_id": 3451,
"prop_id": 11139,
"seq": 5,
"label": "mobile_phone",
"propMapPropImportSetting": {
"prop_map_id": 3451,
"prop_id": 11139,
"blast_flag": 0,
"keep_old_value_flag": 0,
"treat_null_as_value_flag": 0,
"case_sensitive_flag": 0,
"multivalue_append_flag": 0,
"skip_email_ban_flag": 0
}
},
],
"propMapPropRules": [],
"obj": {
"obj_id": 33900,
"display_name": "Test data map",
"type_id": "PropertyMap",
"ref_id": 3451,
"parent_obj_id": 11440,
"eligibility_status_id": "READY"
}
}
POST Method
The Data Map endpoint supports the following POST operation. This endpoint allows you to create a new Data Map by providing the following information:
Your Customer ID.
The Entity ID for the Data Map's source table.
Data Processing options: Create and Update, Update Only, or Create Only
File Information:
Header row
Delimiter character
Text qualifier
Field information; for each field on the source table to be included in the Data Map:
Field ID (or "Prop ID")
Sequence number
Any Advanced Field Options or special processing
Soft Match fields (if any).
Calculated fields (if any).
The name of the new Data Map.
Click hereClick here to see a sample request message in JSON format.
{
"entity_id": 100,
"cust_id": 394,
"propMapImportSetting":
{
"suppress_new_flag": 1,
"suppress_old_flag": 0
},
"propMapFlat":
{
"first_row": 2,
"separator": "\\t"
},
"propMapProps":
[
{
"prop_id": 1150,
"seq": 1,
"label": "EmailAddr",
"propMapPropImportSetting":
{
"blast_flag": 0,
"keep_old_value_flag": 0,
"treat_null_as_value_flag": 0,
"case_sensitive_flag": 0,
"multivalue_append_flag": 0,
"skip_email_ban_flag": 1
}
},
{
"prop_id": 1100,
"seq": 2,
"label": "FName"
},
{
"prop_id": 13049,
"seq": 3,
"label": "Price",
"culture_name": "en-US"
}
],
"propMapPropRules":
[
{
"prop_id": 15585,
"seq": 1
}
],
"obj": {
"display_name": "Sample Data Map"
}
}
PUT Method
The Data Map endpoint supports the following PUT operation. This endpoint allows you to submit modifications to an existing Data Map. The request message must include the Data Map's Object Reference ID, and the desired changes. Using this endpoint, you can change the Data Map name, modify the file information, modify the data processing options, modify the Advanced Field Options, add new fields, and remove existing fields. To remove a field, simply omit it from the request message; any existing fields that aren't referenced in the request message will be removed.
Click hereClick here to see a sample request message in JSON format.
This example request message adds a new, second field to the Data Map.
{
"prop_map_id": 4274,
"prop_map_name": "Data map API",
"entity_id": 100,
"cust_id": 123,
"propMapImportSetting": {
"prop_map_id": 4274,
"suppress_new_flag": 1,
"suppress_old_flag": 0
},
"propMapFlat": {
"prop_map_id": 4274,
"first_row": 2,
"separator": "\\t"
},
"propMapProps": [
{
"prop_map_id": 4274,
"prop_id": 1150,
"seq": 1,
"propMapPropImportSetting": {
"prop_map_id": 4274,
"prop_id": 1150,
"blast_flag": 0,
"keep_old_value_flag": 0,
"treat_null_as_value_flag": 0,
"case_sensitive_flag": 0,
"multivalue_append_flag": 0,
"skip_email_ban_flag": 0
}
},
{
"prop_map_id": 4274,
"prop_id": 1100,
"seq": 2,
"propMapPropImportSetting": {
"prop_map_id": 4274,
"prop_id": 1100,
"blast_flag": 0,
"keep_old_value_flag": 0,
"treat_null_as_value_flag": 0,
"case_sensitive_flag": 0,
"multivalue_append_flag": 0,
"skip_email_ban_flag": 0
}
}
],
"propMapPropRules": [],
"obj": {
"obj_id": 45815,
"display_name": "Data map API",
"type_id": "PropertyMap",
"ref_id": 4274,
"parent_obj_id": 37249,
"eligibility_status_id": "READY"
}
}
Click hereClick here to see a sample response message in JSON format.
{
"prop_map_id": 4274,
"prop_map_name": "Data map API",
"entity_id": 100,
"cust_id": 123,
"propMapImportSetting": {
"prop_map_id": 4274,
"suppress_new_flag": 1,
"suppress_old_flag": 0
},
"propMapFlat": {
"prop_map_id": 4274,
"first_row": 2,
"separator": "\\t"
},
"propMapProps": [
{
"prop_map_id": 4274,
"prop_id": 1150,
"seq": 1,
"propMapPropImportSetting": {
"prop_map_id": 4274,
"prop_id": 1150,
"blast_flag": 0,
"keep_old_value_flag": 0,
"treat_null_as_value_flag": 0,
"case_sensitive_flag": 0,
"multivalue_append_flag": 0,
"skip_email_ban_flag": 0
}
},
{
"prop_map_id": 4274,
"prop_id": 1100,
"seq": 2,
"propMapPropImportSetting": {
"prop_map_id": 4274,
"prop_id": 1100,
"blast_flag": 0,
"keep_old_value_flag": 0,
"treat_null_as_value_flag": 0,
"case_sensitive_flag": 0,
"multivalue_append_flag": 0,
"skip_email_ban_flag": 0
}
}
],
"propMapPropRules": [],
"obj": {
"obj_id": 45815,
"display_name": "Data map API",
"type_id": "PropertyMap",
"ref_id": 4274,
"parent_obj_id": 37249,
"eligibility_status_id": "READY"
}
}
DELETE Method
The Data Map endpoint supports a DELETE operation that will delete the specified Data Map. You must provide the Object Reference ID for the desired Data Map.
Note: Deleted Data Maps are permanently deleted, and can't be restored.
Back to API Category - Data Management