These docs are for v1.0.2. Click to read the latest docs for v2.9.0.

A Destination Account is a distribution to one "seat" at a destination. In most cases, you will only have one seat per destination.

Creating a new Distribution (Under development)

Destinations will typically require unique properties when receiving data from LiveRamp to ensure your data is correctly mapped to your account.

To create a new distribution -- follow these steps.

  1. Retrieve the list of Destinations
  2. Retrieve a Distribution Template for your desired destination. This template will contain properties required to distribute your data. The template values will be blank.
  3. Populate the template
  • Name your account
  • Select which device types you'd like to distribute
  • Populate the values for all required properties.
  1. POST the populated template to create a new account. Only include the following objects:
  • Destination ID
  • Name of your account
  • Selected Device types
  • Populated properties

Example:

curl -X GET \
  https://api.liveramp.net/v1/distribution/destinations \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'x-api-key: your_api_key'
  
Response:

{
	"destinations": [{
		"id": 1234,
		"name": "Example Destination"
	}]
}
curl -X GET \
  https://api.liveramp.net/v1/distribution/accounts/new?destination_id=1234 \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'x-api-key: your_api_key'
  
Response:

{
	"account": {
		"destination_id": 1234,
		"name": "",
		"device_types": [
			"web",
			"ios",
			"android"
		],
		"properties": [{
			"name": "advertiser_id",
			"needed_for_device_types": [
				"web",
				"ios",
				"android"
			],
			"description": "Your advertiser ID at the destination platform.",
			"value": ""
		}]
	}
}
{
	"account": {
		"destination_id": 1234,
		"name": "My_Test_Account",
		"device_types": [
			"web",
			"android"
		],
		"properties": [{
			"name": "advertiser_id",
			"needed_for_device_types": [
				"web",
				"ios",
				"android"
			],
			"description": "Your advertiser ID at the destination platform.",
			"value": "ABC_123"
		}]
	}
}
curl -X POST \
  https://connect-distribution-api-staging-t01.liveramp.net/v1/distribution/accounts \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'x-api-key: your_api_key'
  -d '{
	"account": {
		"destination_id": 1234,
		"name": "My_Test_Account",
		"device_types": ["android", "web"],
		"properties": [{
			"name": "advertiser_id",
			"value": "ABC_123"
		}]
	}
}'

Response:

{
	"account": {
		"id": 99999,
		"name": "My_Test_Account",
		"device_types": ["android", "web"],
		"status": "active"
	}
}