Connect to file-based email marketing destinations and activate data using the Flow Service API
-
To connect to a destination, you need the View Destinations and Manage Destinations access control permissions.
-
To activate data, you need the View Destinations, Activate Destinations, View Profiles, and View Segments access control permissions.
-
To export identities, you need the View Identity Graph access control permission.\
img-md w-100 modal-image
This tutorial demonstrates how to use the Flow Service API to create a file-based email marketing destination, create a dataflow to your newly created destination, and export data to your newly created destination via CSV files.
This tutorial uses the Adobe Campaign destination in all examples, but the steps are identical for file-based email marketing destinations.
If you prefer to use the Platform user interface to connect to a destination and activate data, see the Connect a destination and Activate audience data to batch profile export destinations tutorials.
Getting started get-started
This guide requires a working understanding of the following components of Adobe Experience Platform:
- Experience Data Model (XDM) System: The standardized framework by which Experience Platform organizes customer experience data.
- Segmentation Service: Adobe Experience Platform Segmentation Service allows you to build audiences in Adobe Experience Platform from your Real-Time Customer Profile data.
- Sandboxes: Experience Platform provides virtual sandboxes which partition a single Platform instance into separate virtual environments to help develop and evolve digital experience applications.
The following sections provide additional information that you need to know in order to activate data to batch destinations in Platform.
Gather required credentials gather-required-credentials
To complete the steps in this tutorial, you should have the following credentials ready, depending on the type of destination that you are connecting and activating audiences to.
- For Amazon S3 connections:
accessId
,secretKey
- For Amazon S3 connections to Adobe Campaign:
accessId
,secretKey
- For SFTP connections:
domain
,port
,username
,password
orsshKey
(depending on the connection method to the FTP location) - For Azure Blob connections:
connectionString
accessId
, secretKey
for Amazon S3 connections and accessId
, secretKey
for Amazon S3 connections to Adobe Campaign are identical.Reading sample API calls reading-sample-api-calls
This tutorial provides example API calls to demonstrate how to format your requests. These include paths, required headers, and properly formatted request payloads. Sample JSON returned in API responses is also provided. For information on the conventions used in documentation for sample API calls, see the section on how to read example API calls in the Experience Platform troubleshooting guide.
Gather values for required and optional headers gather-values-headers
In order to make calls to Platform APIs, you must first complete the authentication tutorial. Completing the authentication tutorial provides the values for each of the required headers in all Experience Platform API calls, as shown below:
- Authorization: Bearer
{ACCESS_TOKEN}
- x-api-key:
{API_KEY}
- x-gw-ims-org-id:
{ORG_ID}
Resources in Experience Platform can be isolated to specific virtual sandboxes. In requests to Platform APIs, you can specify the name and ID of the sandbox that the operation will take place in. These are optional parameters.
- x-sandbox-name:
{SANDBOX_NAME}
All requests that contain a payload (POST, PUT, PATCH) require an additional media type header:
- Content-Type:
application/json
API reference documentation api-reference-documentation
You can find accompanying reference documentation for all the API operations in this tutorial. Refer to the Flow Service API documentation on Adobe I/O. We recommend that you use this tutorial and the API reference documentation in parallel.
Get the list of available destinations get-the-list-of-available-destinations
As a first step, you should decide which destination to activate data to. To begin with, perform a call to request a list of available destinations that you can connect and activate audiences to. Perform the following GET request to the connectionSpecs
endpoint to return a list of available destinations:
API format
GET /connectionSpecs
Request
curl --location --request GET 'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs' \
--header 'accept: application/json' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}'
Response
A successful response contains a list of available destinations and their unique identifiers (id
). Store the value of the destination that you plan to use, as it will be required in further steps. For example, if you want to connect and deliver audiences to Adobe Campaign, look for the following snippet in the response:
{
"id": "0b23e41a-cb4a-4321-a78f-3b654f5d7d97",
"name": "Adobe Campaign",
...
...
}
For your reference, the table below contains the connection spec IDs for commonly used batch destinations:
0b23e41a-cb4a-4321-a78f-3b654f5d7d97
c1e44b6b-e7c8-404b-9031-58f0ef760604
a5e28ddf-e265-426e-83a1-9d03a3a6822b
f599a5b3-60a7-4951-950a-cc4115c7ea27
Connect to your Experience Platform data connect-to-your-experience-platform-data
Next, you must connect to your Experience Platform data, so you can export profile data and activate it in your preferred destination. This consists of two substeps which are described below.
- First, you must perform a call to authorize access to your data in Experience Platform, by setting up a base connection.
- Then, using the base connection ID, perform another call in which you create a source connection, which establishes the connection to your Experience Platform data.
Authorize access to your data in Experience Platform
API format
POST /connections
Request
curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/connections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Base connection to Experience Platform",
"description": "This call establishes the connection to Experience Platform data",
"connectionSpec": {
"id": "{CONNECTION_SPEC_ID}",
"version": "1.0"
}
}'
name
description
connectionSpec.id
8a9c3494-9708-43d7-ae3f-cda01e5030e1
.Response
A successful response contains the base connection’s unique identifier (id
). Store this value as it is required in the next step to create the source connection.
{
"id": "1ed86558-59b5-42f7-9865-5859b552f7f4"
}
Connect to your Experience Platform data connect-to-platform-data
API format
POST /sourceConnections
Request
curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Connecting to Profile Store",
"description": "Optional",
"connectionSpec": {
"id": "{CONNECTION_SPEC_ID}",
"version": "1.0"
},
"baseConnectionId": "{BASE_CONNECTION_ID}",
"data": {
"format": "CSV",
"schema": null
},
"params" : {}
}'
name
description
connectionSpec.id
8a9c3494-9708-43d7-ae3f-cda01e5030e1
.baseConnectionId
data.format
CSV
is currently the only supported file export format.Response
A successful response returns the unique identifier (id
) for the newly created source connection to Profile Store. This confirms that you have successfully connected to your Experience Platform data. Store this value as it is required in a later step.
{
"id": "ed48ae9b-c774-4b6e-88ae-9bc7748b6e97"
}
Connect to batch destination connect-to-batch-destination
In this step, you are setting up a connection to your desired batch cloud storage or email marketing destination. This consists of two substeps which are described below.
- First, you must perform a call to authorize access to the destination platform, by setting up a base connection.
- Then, using the base connection ID, you will make another call in which you create a target connection, which specifies the location in your storage account where the exported data files will be delivered, as well as the format of the data that will be exported.
Authorize access to the batch destination authorize-access-to-batch-destination
API format
POST /connections
Request
The request below establishes a base connection to Adobe Campaign destinations. Depending on the storage location where you want to export files to (Amazon S3, SFTP, Azure Blob), keep the appropriate auth
specification and delete the others.
curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/connections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "S3 Connection for Adobe Campaign",
"description": "summer advertising campaign",
"connectionSpec": {
"id": "0b23e41a-cb4a-4321-a78f-3b654f5d7d97",
"version": "1.0"
},
"auth": {
"specName": "S3",
"params": {
"accessId": "{ACCESS_ID}",
"secretKey": "{SECRET_KEY}"
}
}
"auth": {
"specName": "SFTP with Password",
"params": {
"domain": "{DOMAIN}",
"host": "{HOST}",
"username": "{USERNAME}",
"password": "{PASSWORD}"
}
}
"auth": {
"specName": "SFTP with SSH Key",
"params": {
"domain": "{DOMAIN}",
"host": "{HOST}",
"username": "{USERNAME}",
"sshKey": "{SSH_KEY}"
}
}
"auth": {
"specName": "Azure Blob",
"params": {
"connectionString": "{AZURE_BLOB_CONNECTION_STRING}"
}
}
}'
See the example requests below to connect to other supported batch cloud storage and email marketing destinations.
The request below establishes a base connection to Amazon S3 destinations.
code language-shell |
---|
|
The request below establishes a base connection to Azure Blob destinations.
code language-shell |
---|
|
The request below establishes a base connection to Oracle Eloqua destinations. Depending on the storage location where you want to export files to, keep the appropriate auth
specification and delete the others.
code language-shell |
---|
|
The request below establishes a base connection to Oracle Responsys destinations. Depending on the storage location where you want to export files to, keep the appropriate auth
specification and delete the others.
code language-shell |
---|
|
The request below establishes a base connection to Salesforce Marketing Cloud destinations. Depending on the storage location where you want to export files to, keep the appropriate auth
specification and delete the others.
code language-shell |
---|
|
The request below establishes a base connection to SFTP destinations.
code language-shell |
---|
|
name
description
connectionSpec.id
auth.specname
authSpec.name
in the response.For example, for Adobe Campaign destinations, you can use any of
S3
, SFTP with Password
, or SFTP with SSH Key
.params
To find out the required parameters for your destination, perform a GET call to the connection specs endpoint, providing the connection spec of your desired destination. Look for the parameter
authSpec.spec.required
in the response.Response
A successful response contains the base connection’s unique identifier (id
). Store this value as it is required in the next step to create a target connection.
{
"id": "1ed86558-59b5-42f7-9865-5859b552f7f4"
}
Specify storage location and data format specify-storage-location-data-format
Adobe Experience Platform exports data for batch email marketing and cloud storage destinations in the form of CSV files. In this step, you can determine the path in your storage location where the files will be exported.
filename.csv
, filename_2.csv
, filename_3.csv
.API format
POST /targetConnections
Request
The request below establishes a target connection to Adobe Campaign destinations, to determine where the exported files will land in your storage location. Depending on the storage location where you want to export files to, keep the appropriate params
specification and delete the others.
curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/targetConnections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "TargetConnection for Adobe Campaign",
"description": "Connection to Adobe Campaign",
"baseConnectionId": "{BASE_CONNECTION_ID}",
"connectionSpec": {
"id": "0b23e41a-cb4a-4321-a78f-3b654f5d7d97",
"version": "1.0"
},
"data": {
"format": "json",
"schema": {
"id": "1.0",
"version": "1.0"
}
},
"params": {
"mode": "S3",
"bucketName": "{BUCKET_NAME}",
"path": "{FILEPATH}",
"format": "CSV"
}
"params": {
"mode": "AZURE_BLOB",
"container": "{CONTAINER}",
"path": "{FILEPATH}",
"format": "CSV"
}
"params": {
"mode": "FTP",
"remotePath": "{REMOTE_PATH}",
"format": "CSV"
}
}'
See the example requests below to set up a storage location for other supported batch cloud storage and email marketing destinations.
The request below establishes a target connection to Amazon S3 destinations, to determine where the exported files will land in your storage location.
code language-shell |
---|
|
The request below establishes a target connection to Azure Blob destinations, to determine where the exported files will land in your storage location.
code language-shell |
---|
|
The request below establishes a target connection to Oracle Eloqua destinations, to determine where the exported files will land in your storage location. Depending on the storage location where you want to export files to, keep the appropriate params
specification and delete the others.
code language-shell |
---|
|
The request below establishes a target connection to Oracle Responsys destinations, to determine where the exported files will land in your storage location. Depending on the storage location where you want to export files to, keep the appropriate params
specification and delete the others.
code language-shell |
---|
|
The request below establishes a target connection to Salesforce Marketing Cloud destinations, to determine where the exported files will land in your storage location. Depending on the storage location where you want to export files to, keep the appropriate params
specification and delete the others.
code language-shell |
---|
|
The request below establishes a target connection to SFTP destinations, to determine where the exported files will land in your storage location.
code language-shell |
---|
|
name
description
baseConnectionId
connectionSpec.id
params
To find out the required parameters for your destination, perform a GET call to the connection specs endpoint, providing the connection spec of your desired destination. Look for the parameter
targetSpec.spec.required
in the response.params.mode
targetSpec.spec.properties.mode.enum
in the response and select the desired mode.params.bucketName
params.path
params.format
CSV
is currently the only supported file export type.Response
A successful response returns the unique identifier (id
) for the newly created target connection to your batch destination. Store this value as it is required in later steps.
{
"id": "12ab90c7-519c-4291-bd20-d64186b62da8"
}
Create a dataflow create-dataflow
Using the flow spec, source connection, and target connection IDs that you obtained in the previous steps, you can now create a dataflow between your Experience Platform data and the destination where you will export data files. Think of this step as constructing the pipeline through which data will later flow between Experience Platform and your desired destination.
To create a dataflow, perform a POST request as shown below, while providing the values mentioned below within the payload.
API format
POST /flows
Request
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/flows' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "activate audiences to Adobe Campaign",
"description": "This operation creates a dataflow which we will later use to activate audiences to Adobe Campaign",
"flowSpec": {
"id": "{FLOW_SPEC_ID}",
"version": "1.0"
},
"sourceConnectionIds": [
"{SOURCE_CONNECTION_ID}"
],
"targetConnectionIds": [
"{TARGET_CONNECTION_ID}"
],
"transformations": [
{
"name": "GeneralTransform",
"params": {
"segmentSelectors": {
"selectors": []
},
"profileSelectors": {
"selectors": []
}
}
}
]
}
name
description
flowSpec.Id
flowspecs
endpoint, as shown in the flow specs API reference documentation. In the response, look for upsTo
and copy the corresponding ID of the batch destination that you want to connect to. For example, for Adobe Campaign, look for upsToCampaign
and copy the id
parameter.sourceConnectionIds
targetConnectionIds
transformations
For your reference, the table below contains the flow spec IDs for commonly used batch destinations:
71471eba-b620-49e4-90fd-23f1fa0174d8
51d675ce-e270-408d-91fc-22717bdf2148
493b2bd6-26e4-4167-ab3b-5e910bba44f0
Response
A successful response returns the ID (id
) of the newly created dataflow and an etag
. Note down both values as you will need them in the next step, to activate audiences and export data files.
{
"id": "8256cfb4-17e6-432c-a469-6aedafb16cd5",
"etag": "8256cfb4-17e6-432c-a469-6aedafb16cd5"
}
Activate data to your new destination activate-data
Having created all the connections and the dataflow, you now can activate your profile data to the destination platform. In this step, you select which audiences and which profile attributes to export to the destination.
You can also determine the file naming format of the exported files and which attributes should be used as deduplication keys or mandatory attributes. In this step, you can also determine the schedule to send data to the destination.
To activate audiences to your new destination, you must perform a JSON PATCH operation, similar to the example below. You can activate mutiple audiences and profile attributes in one call. To learn more about JSON PATCH, see the RFC specification.
API format
PATCH /flows
Request
curl --location --request PATCH 'https://platform.adobe.io/data/foundation/flowservice/flows/{DATAFLOW_ID}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'Content-Type: application/json' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'If-Match: "{ETAG}"' \
--data-raw '[
{
"op": "add",
"path": "/transformations/0/params/segmentSelectors/selectors/-",
"value": {
"type": "PLATFORM_SEGMENT",
"value": {
"name": "Name of the audience that you are activating",
"description": "Description of the audience that you are activating",
"id": "{SEGMENT_ID}",
"filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
"exportMode": "DAILY_FULL_EXPORT",
"schedule": {
"frequency": "ONCE",
"startDate": "2021-12-20",
"startTime": "17:00"
}
}
}
},
{
"op": "add",
"path": "/transformations/0/params/segmentSelectors/selectors/-",
"value": {
"type": "PLATFORM_SEGMENT",
"value": {
"name": "Name of the audience that you are activating",
"description": "Description of the audience that you are activating",
"id": "{SEGMENT_ID}",
"filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
"exportMode": "DAILY_FULL_EXPORT",
"schedule": {
"frequency": "ONCE",
"triggerType": "SCHEDULED",
"startDate": "2021-12-20",
"startTime": "17:00"
},
}
}
},
{
"op": "add",
"path": "/transformations/0/params/profileSelectors/selectors/-",
"value": {
"type": "JSON_PATH",
"value": {
"path": "{PROFILE_ATTRIBUTE}"
}
}
}
]
{DATAFLOW_ID}
{ETAG}
Get the {ETAG}
from the response in the previous step, Create a dataflow. The response format in the previous step has escaped quotes. You must use the unescaped values in the header of the request. See the example below:
- Response example:
"etag":""7400453a-0000-1a00-0000-62b1c7a90000""
- Value to use in your request:
"etag": "7400453a-0000-1a00-0000-62b1c7a90000"
The etag value updates with every successful update of a dataflow.
{SEGMENT_ID}
{PROFILE_ATTRIBUTE}
"person.lastName"
op
add
, replace
, and remove
. To add an audience to a dataflow, use the add
operation.path
value
id
name
filenameTemplate
This field determines the file name format of the files that are exported to your destination.
The following options are available:
%DESTINATION_NAME%
: Mandatory. The exported files contain the destination name.%SEGMENT_ID%
: Mandatory. The exported files contain the ID of the exported audience.%SEGMENT_NAME%
: Optional. The exported files contain the name of the exported audience.DATETIME(YYYYMMdd_HHmmss)
or%TIMESTAMP%
: Optional. Select one of these two options for your files to include the time when they are generated by Experience Platform.custom-text
: Optional. Replace this placeholder with any custom text that you would like to append at the end of your file names.
For more information about configuring file names, refer to the configure file names section in the batch destinations activation tutorial.
exportMode
"DAILY_FULL_EXPORT"
or "FIRST_FULL_THEN_INCREMENTAL"
. For more information about the two options, refer to export full files and export incremental files in the batch destinations activation tutorial.startDate
frequency
Mandatory.
- For the
"DAILY_FULL_EXPORT"
export mode, you can selectONCE
orDAILY
. - For the
"FIRST_FULL_THEN_INCREMENTAL"
export mode, you can select"DAILY"
,"EVERY_3_HOURS"
,"EVERY_6_HOURS"
,"EVERY_8_HOURS"
,"EVERY_12_HOURS"
.
triggerType
For batch destinations only. This field is required only when selecting the "DAILY_FULL_EXPORT"
mode in the frequency
selector.
Mandatory.
- Select
"AFTER_SEGMENT_EVAL"
to have the activation job run immediately after the daily Platform batch segmentation job completes. This ensures that when the activation job runs, the most up-to-date profiles are exported to your destination. - Select
"SCHEDULED"
to have the activation job run at a fixed time. This ensures that Experience Platform profile data is exported at the same time each day, but the profiles you export may not be the most up-to-date, depending on whether the batch segmentation job has completed before the activation job starts. When selecting this option, you must also add astartTime
to indicate at which time in UTC the daily exports should occur.
endDate
Not applicable when selecting
"exportMode":"DAILY_FULL_EXPORT"
and "frequency":"ONCE"
.Sets the date when audience members stop being exported to the destination.
startTime
Mandatory. Select the time when files containing members of the audience should be generated and exported to your destination.
Response
Look for a 202 Accepted response. No response body is returned. To validate that the request was correct, see the next step, Validate the dataflow.
Validate the dataflow validate-dataflow
As a final step in the tutorial, you should validate that the audiences and profile attributes have indeed been correctly mapped to the dataflow.
To validate this, perform the following GET request:
API format
GET /flows
Request
curl --location --request PATCH 'https://platform.adobe.io/data/foundation/flowservice/flows/{DATAFLOW_ID}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'Content-Type: application/json' \
--header 'x-sandbox-name: prod' \
--header 'If-Match: "{ETAG}"'
{DATAFLOW_ID}
: Use the dataflow from the previous step.{ETAG}
: Use the etag from the previous step.
Response
The returned response should include in the transformations
parameter the audiences and profile attributes that you submitted in the previous step. A sample transformations
parameter in the response could look like below:
"transformations":[
{
"name":"GeneralTransform",
"params":{
"profileSelectors":{
"selectors":[
{
"type":"JSON_PATH",
"value":{
"path":"homeAddress.countryCode",
"operator":"EXISTS",
"mapping":{
"sourceType":"text/x.schema-path",
"source":"homeAddress.countryCode",
"destination":"homeAddress.countryCode",
"identity":false,
"primaryIdentity":false,
"functionVersion":0,
"copyModeMapping":false,
"sourceAttribute":"homeAddress.countryCode",
"destinationXdmPath":"homeAddress.countryCode"
}
}
},
{
"type":"JSON_PATH",
"value":{
"path":"person.name.firstName",
"operator":"EXISTS",
"mapping":{
"sourceType":"text/x.schema-path",
"source":"person.name.firstName",
"destination":"person.name.firstName",
"identity":false,
"primaryIdentity":false,
"functionVersion":0,
"copyModeMapping":false,
"sourceAttribute":"person.name.firstName",
"destinationXdmPath":"person.name.firstName"
}
}
},
{
"type":"JSON_PATH",
"value":{
"path":"person.name.lastName",
"operator":"EXISTS",
"mapping":{
"sourceType":"text/x.schema-path",
"source":"person.name.lastName",
"destination":"person.name.lastName",
"identity":false,
"primaryIdentity":false,
"functionVersion":0,
"copyModeMapping":false,
"sourceAttribute":"person.name.lastName",
"destinationXdmPath":"person.name.lastName"
}
}
},
{
"type":"JSON_PATH",
"value":{
"path":"personalEmail.address",
"operator":"EXISTS",
"mapping":{
"sourceType":"text/x.schema-path",
"source":"personalEmail.address",
"destination":"personalEmail.address",
"identity":false,
"primaryIdentity":false,
"functionVersion":0,
"copyModeMapping":false,
"sourceAttribute":"personalEmail.address",
"destinationXdmPath":"personalEmail.address"
}
}
},
{
"type":"JSON_PATH",
"value":{
"path":"segmentMembership.status",
"operator":"EXISTS",
"mapping":{
"sourceType":"text/x.schema-path",
"source":"segmentMembership.status",
"destination":"segmentMembership.status",
"identity":false,
"primaryIdentity":false,
"functionVersion":0,
"copyModeMapping":false,
"sourceAttribute":"segmentMembership.status",
"destinationXdmPath":"segmentMembership.status"
}
}
}
],
"mandatoryFields":[
"person.name.firstName",
"person.name.lastName"
],
"primaryFields":[
{
"fieldType":"ATTRIBUTE",
"attributePath":"personalEmail.address"
}
]
},
"segmentSelectors":{
"selectors":[
{
"type":"PLATFORM_SEGMENT",
"value":{
"id":"9f7d37fd-7039-4454-94ef-2b0cd6c3206a",
"name":"Interested in Mountain Biking",
"filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
"exportMode":"DAILY_FULL_EXPORT",
"schedule":{
"frequency":"ONCE",
"startDate":"2021-12-20",
"startTime":"17:00"
},
"createTime":"1640016962",
"updateTime":"1642534355"
}
},
{
"type":"PLATFORM_SEGMENT",
"value":{
"id":"25768be6-ebd5-45cc-8913-12fb3f348613",
"name":"Loyalty Segment",
"filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
"exportMode":"FIRST_FULL_THEN_INCREMENTAL",
"schedule":{
"frequency":"EVERY_6_HOURS",
"startDate":"2021-12-22",
"endDate":"2021-12-31",
"startTime":"17:00"
},
"createTime":"1640016962",
"updateTime":"1642534355"
}
}
]
}
}
}
]
API error handling api-error-handling
The API endpoints in this tutorial follow the general Experience Platform API error message principles. Refer to API status codes and request header errors in the Platform troubleshooting guide for more information on interpreting error responses.
Next steps next-steps
By following this tutorial, you have successfully connected Platform to one of your preferred file-based email marketing destinations and set up a dataflow to the respective destination to export data files. Outgoing data can now be used in the destination for email campaigns, targeted advertising, and many other use cases. See the following pages for more details, such as how to edit existing dataflows using the Flow Service API: