Create Destinations create-destinations
Create destinations with these RESTful API methods.
Supported Destination Types: URL and Cookie Only
The available POST methods let you create URL and cookie destinations only. Currently, you cannot create server-to-server destinations with these REST API methods. However, the related destination GET methods let you retrieve information about server-to-server destinations created in the user interface.
Create a Non-Serial URL Destination create-nonserial-dest
A POST method that lets you create a destination that accepts segments composed of single key-value pairs (e.g., gender=male or gender=female).
Request
POST https://api.demdex.com/v1/destinations/
Sample Request
This request creates a single destination. All request values are required unless otherwise indicated.
{
"name":"Sample URL Destination (not serialized)",
"description":"",
"destinationType":"PUSH",
"serializationEnabled":false
}
Response
A successful request returns 201 created and the destination.
{
"destinationType":"PUSH",
"destinationId":4033,
"dataSourceId":null,
"pid":1099,
"name":"Sample URL Destination (not serialized)",
"description":"",
"startDate":null,
"endDate":null,
"status":"ACTIVE",
"destinationType":"PUSH",
"createTime":1338937116000,
"updateTime":1338937116000,
"crUID":694,
"upUID":694,
"domainRestrictions":"all_domains",
"tagType":0,
"serializationEnabled":false,
"urlFormatString":"https://www.adobe.com/send?%ALIAS%",
"secureUrlFormatString":"https://www.adobe.com/send?%ALIAS%",
"delimiter":null,
"mappings":null
}
Create a Serialized URL Destination create-serial-url-dest
A POST method that lets you create a destination that accepts multiple values associated with a single key (e.g., color=blue, red, green).
Request
POST https://api.demdex.com/v1/destinations/
Sample Request
Specify the secure URL and delimiter for the key-value pair passed in to the destination. All request values are required unless otherwise indicated.
{
"name":"Sample URL Destination (Serialized)",
"description":"",
"destinationType":"PUSH",
"serializationEnabled":true,
"urlFormatString":"https://www.adobe.com/send?data=%ALIAS%",
"secureUrlFormatString":"https://www.adobe.com/%ALIAS%",
"delimiter":","
}
Response
A successful update returns response code 201 created and the destination.
{
"destinationType":"PUSH",
"destinationId":4034,
"dataSourceId":null,
"pid":1099,
"name":"Sample URL Destination (Serialized)",
"description":"",
"startDate":null,
"endDate":null,
"status":"active",
"destinationType":"PUSH",
"createTime":1338937420000,
"updateTime":1338937420000,
"crUID":694,
"upUID":694,
"domainRestrictions":"all_domains",
"tagType":0,
"serializationEnabled":true,
"urlFormatString":"https://www.adobe.com/send?%ALIAS%",
"secureUrlFormatString":"https://www.adobe.com/%ALIAS%",
"delimiter":"-",
"mappings":null
}
Create a Cookie Destination: Single-Key, Non-Serialized create-cookie-dest-single
A POST method that lets you create a cookie destination that accepts segments composed of single key-value pairs (e.g., gender=male or gender=female).
Request
POST https://api.demdex.com/v1/destinations/
Sample Request
All request values are required unless otherwise indicated.
{
"name":"Cookie Destination Single Key Not Serialized",
"destinationType":"ADS",
"adServerTypeID":1,
"cookieName":"adobe",
"cnameDomain":"adobe.com",
"maxSize":"2048",
"ttl":"0",
"domainRestrictions":"inclusion",
"siteIDs":[
312
],
"formatType":"single_key",
"singleKey":"key",
"keySeparator":"=",
"valueSeparator":",",
"serializationEnabled":false
}
Response
A successful update returns response code 201 created and the destination.
{
"destinationType":"ADS",
"destinationId":4035,
"pid":1099,
"name":"Cookie Destination Single Key Not Serialized",
"status":"active",
"destinationType":"ADS",
"createTime":1338937984000,
"updateTime":1338937984000,
"crUID":694,
"upUID":694,
"domainRestrictions":"inclusion",
"cnameDomain":"adobe.com",
"cookieName":"adobe",
"singleKey":"key",
"keySeparator":"=",
"valueSeparator":",",
"formatType":"single_key",
"transferMethod":0,
"serializationEnabled":false,
"maxSize":2048,
"ttl":0,
"siteIDs":[
312
],
"uparamEnabled":false
}
Create a Cookie Destination: Single Key, Serialized create-cookie-dest-single-serial
A POST method that lets you create a destination that accepts multiple values associated with a single key (e.g., color=blue, red, green).
Request
POST https://api.demdex.com/v1/destinations/
Sample Request
All request values are required unless otherwise indicated.
{
"name":"Cookie Destination Single Key Serialized",
"destinationType":"ADS",
"adServerTypeID":1,
"cookieName":"adobe",
"cnameDomain":"adobe.com",
"maxSize":"2048",
"ttl":"0",
"domainRestrictions":"all_domains",
"siteIDs":[
],
"formatType":"single_key",
"singleKey":"k",
"keySeparator":"=",
"valueSeparator":",",
"serializationEnabled":true,
"serializationSeparator":"#"
}
Response
A successful update returns response code 201 created and the destination.
{
"destinationType":"ADS",
"destinationId":4036,
"pid":1099,
"name":"Cookie Destination Single Key Serialized",
"status":"active",
"destinationType":"ADS",
"createTime":1338938329000,
"updateTime":1338938329000,
"crUID":694,
"upUID":694,
"domainRestrictions":"all_domains",
"cnameDomain":"adobe.com",
"cookieName":"adobe",
"singleKey":"k",
"keySeparator":"=",
"valueSeparator":",",
"formatType":"single_key",
"transferMethod":0,
"serializationEnabled":true,
"serializationSeparator":"#",
"maxSize":2048,
"ttl":0,
"siteIDs":[
],
"uparamEnabled":false
}
Create a Cookie Destination: Multi-Key, Non-Serialized create-cookie-dest-multi
A POST method that lets you create a destination that accepts segments that contain multiple keys with different values (e.g., gender=male; gender=female; color=blue; color=red).
Request
POST https://api.demdex.com/v1/destinations/
Sample Request
All request values are required unless otherwise indicated.
{
"name":"Ad Server Multi-Key Not Serialized",
"destinationType":"ADS",
"adServerTypeID":1,
"cookieName":"adobe",
"cnameDomain":"adobe.com",
"maxSize":"2048",
"ttl":"0",
"domainRestrictions":"all_domains",
"siteIDs":[
],
"formatType":"key_value",
"keySeparator":"=",
"valueSeparator":",",
"serializationEnabled":false
}
Response
A successful update returns response code 201 created and the destination.
{
"destinationType":"ADS",
"destinationId":4037,
"pid":1099,
"name":"Ad Server Multi-Key Not Serialized",
"status":1,
"destinationType":"ADS",
"createTime":1338938666000,
"updateTime":1338938666000,
"crUID":694,
"upUID":694,
"domainRestrictions":"all_domains",
"cnameDomain":"adobe.com",
"cookieName":"adobe",
"keySeparator":"=",
"valueSeparator":",",
"formatType":"key_value",
"transferMethod":0,
"serializationEnabled":false,
"maxSize":2048,
"ttl":0,
"siteIDs":[
],
"uparamEnabled":false
}
Create a Cookie Destination: Multi-Key, Serialized create-cookie-dest-multi-serial
A POST method that lets you create a destination that accepts segments that contain multiple keys and values (e.g., gender=male, female; color=blue, red, green).
Request
POST https://api.demdex.com/v1/destinations/
Sample Request
All request values are required unless otherwise indicated.
{
"name":"Cookie Destination Multi-Key Serialized",
"destinationType":"ADS",
"adServerTypeID":1,
"cookieName":"adobe",
"cnameDomain":"adobe.com",
"maxSize":"2048",
"ttl":"0",
"domainRestrictions":"all_domains",
"siteIDs":[
],
"formatType":"key_value",
"keySeparator":"=",
"valueSeparator":",",
"serializationEnabled":true,
"serializationSeparator":"#"
}
Response
A successful update returns response code 201 created and the destination.
{
"destinationType":"ADS",
"destinationId":4038,
"pid":1099,
"name":"Ad Server Multi-Key Serialized",
"status":"active",
"destinationType":"ADS",
"createTime":1338938872000,
"updateTime":1338938872000,
"crUID":694,
"upUID":694,
"domainRestrictions":"all_domains",
"cnameDomain":"adobe.com",
"cookieName":"adobe",
"keySeparator":"=",
"valueSeparator":",",
"formatType":"key_value",
"transferMethod":0,
"serializationEnabled":true,
"serializationSeparator":"#",
"maxSize":2048,
"ttl":0,
"siteIDs":[
],
"uparamEnabled":false
}