Destinations endpoint API operations

IMPORTANT

API endpoint: platform.adobe.io/data/core/activation/authoring/destinations

This page lists and describes all the API operations that you can perform using the /authoring/destinations API endpoint. For a description of the functionality supported by this endpoint, read destination configuration.

Getting started with destination API operations

Before continuing, please review the getting started guide for important information that you need to know in order to successfully make calls to the API, including how to obtain the required destination authoring permission and required headers.

Create configuration for a destination

You can create a new destination configuration by making a POST request to the /authoring/destinations endpoint.

API format

POST /authoring/destinations

Request

The following request creates a new destination configuration, configured by the parameters provided in the payload. The payload below includes all parameters accepted by the /authoring/destinations endpoint. Note that you do not have to add all parameters on the call and that the template is customizable, according to your API requirements.

curl -X POST https://platform.adobe.io/data/core/activation/authoring/destinations \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
   "name":"Moviestar",
   "description":"Moviestar is a fictional destination, used for this example.",
   "status":"TEST",
   "customerAuthenticationConfigurations":[
      {
         "authType":"BEARER"
      }
   ],
   "customerDataFields":[
      {
         "name":"endpointsInstance",
         "type":"string",
         "title":"Select Endpoint",
         "description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
         "isRequired":true,
         "enum":[
            "US",
            "EU",
            "APAC",
            "NZ"
         ]
      },
      {
         "name":"customerID",
         "type":"string",
         "title":"Moviestar Customer ID",
         "description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
         "isRequired":true,
         "pattern":"^[A-Za-z]+$"
      }
   ],
   "uiAttributes":{
      "documentationLink":"https://www.adobe.com/go/destinations-moviestar-en",
      "category":"mobile",
      "connectionType":"Server-to-server",
      "frequency":"Streaming"
   },
   "identityNamespaces":{
      "external_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "Email":{
            }
         }
      },
      "another_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true
      }
   },
   "segmentMappingConfig":{
      "mapExperiencePlatformSegmentName":false,
      "mapExperiencePlatformSegmentId":false,
      "mapUserInput":false,
      "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
   },
   "schemaConfig":{
      "profileFields":[
         {
            "name":"a_custom_attribute",
            "title":"a_custom_attribute",
            "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
            "type":"string",
            "isRequired":false,
            "readOnly":false,
            "hidden":false
         }
      ],
      "profileRequired":true,
      "segmentRequired":true,
      "identityRequired":true
   },
   "aggregation":{
      "aggregationType":"BEST_EFFORT",
      "bestEffortAggregation":{
         "maxUsersPerRequest":10,
         "splitUserById":false
      }
   },
   "destinationDelivery":[
      {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
      }
   ],
   "backfillHistoricalProfileData":true
}
Parameter Type Description
name String Indicates the title of your destination in the Experience Platform catalog
description String Provide a description that Adobe will use in the Experience Platform destinations catalog for your destination card. Aim for no more than 4-5 sentences.
status String Indicates the lifecycle status of the destination card. Accepted values are TEST, PUBLISHED, and DELETED. Use TEST when you first configure your destination.
customerAuthenticationConfigurations String Indicates the configuration used to authenticate Experience Platform customers to your server. See authType below for accepted values.
customerAuthenticationConfigurations.authType String Accepted values are OAUTH2, BEARER.
customerDataFields.name String Provide a name for the custom field you are introducing.
customerDataFields.type String Indicates what type of custom field you are introducing. Accepted values are string, object, integer
customerDataFields.title String Indicates the name of the field, as it is seen by customers in the Experience Platform user interface
customerDataFields.description String Provide a description for the custom field.
customerDataFields.isRequired Boolean Indicates if this field is required in the destination setup workflow.
customerDataFields.enum String Renders the custom field as a dropdown menu and lists the options available to the user.
customerDataFields.pattern String Enforces a pattern for the custom field, if needed. Use regular expressions to enforce a pattern. For example, if your customer IDs don’t include numbers or underscores, enter ^[A-Za-z]+$ in this field.
uiAttributes.documentationLink String Refers to the documentation page in the Destinations Catalog for your destination. Use https://www.adobe.com/go/destinations-YOURDESTINATION-en, where YOURDESTINATION is the name of your destination. For a destination called Moviestar, you would use https://www.adobe.com/go/destinations-moviestar-en.
uiAttributes.category String Refers to the category assigned to your destination in Adobe Experience Platform. For more information, read Destination Categories. Use one of the following values: adobeSolutions, advertising, analytics, cdp, cloudStorage, crm, customerSuccess, database, dmp, ecommerce, email, emailMarketing, enrichment, livechat, marketingAutomation, mobile, personalization, protocols, social, streaming, subscriptions, surveys, tagManagers, voc, warehouses, payments.
uiAttributes.connectionType String Server-to-server is currently the only available option.
uiAttributes.frequency String Streaming is currently the only available option.
identityNamespaces.externalId.acceptsAttributes Boolean Indicates if your destination accepts standard profile attributes. Usually, these attributes are highlighted in our partners’ documentation.
identityNamespaces.externalId.acceptsCustomNamespaces Boolean Indicates if customers can set up custom namespaces in your destination.
identityNamespaces.externalId.allowedAttributesTransformation String Not shown in example configuration. Used, for example, when the Platform customer has plain email addresses as an attribute and your platform only accepts hashed emails. This is where you would provide the transformation that needs to be applied (for example, transform the email to lowercase, then hash).
identityNamespaces.externalId.acceptedGlobalNamespaces - Used for cases when your platform accepts standard identity namespaces (for example, IDFA), so you can restrict Platform users to only selecting these identity namespaces.
When you use acceptedGlobalNamespaces, you can use "requiredTransformation":"sha256(lower($))" to lowercase and hash email addresses or phone numbers.
destinationDelivery.authenticationRule String Indicates how Platform customers connect to your destination. Accepted values are CUSTOMER_AUTHENTICATION, PLATFORM_AUTHENTICATION, NONE.
  • Use CUSTOMER_AUTHENTICATION if Platform customers log into your system via a username and password, a bearer token, or another method of authentication. For example, you would select this option if you also selected authType: OAUTH2 or authType:BEARER in customerAuthenticationConfigurations.
  • Use PLATFORM_AUTHENTICATION if there is a global authentication system between Adobe and your destination and the Platform customer does not need to provide any authentication credentials to connect to your destination. In this case, you must create a credentials object using the Credentials configuration.
  • Use NONE if no authentication is required to send data to your destination platform.
destinationDelivery.destinationServerId String The instanceId of the destination server template used for this destination.
backfillHistoricalProfileData Boolean Controls whether historical profile data is exported when segments are activated to the destination.
  • true: Platform sends the historical user profiles that qualified for the segment before the segment is activated.
  • false: Platform only includes user profiles that qualify for the segment after the segment is activated.
segmentMappingConfig.mapUserInput Boolean Controls whether the segment mapping id in the destination activation workflow is input by user.
segmentMappingConfig.mapExperiencePlatformSegmentId Boolean Controls whether the segment mapping id in the destination activation workflow is the Experience Platform segment ID.
segmentMappingConfig.mapExperiencePlatformSegmentName Boolean Controls whether the segment mapping id in the destination activation workflow is the Experience Platform segment name.
segmentMappingConfig.audienceTemplateId Boolean The instanceId of the audience metadata template used for this destination.
schemaConfig.profileFields Array When you add predefined profileFields as shown in the configuration above, users will have the option of mapping Experience Platform attributes to the predefined attributes on your destination’s side.
schemaConfig.profileRequired Boolean Use true if users should be able to map profile attributes from Experience Platform to custom attributes on your destination’s side, as shown in the example configuration above.
schemaConfig.segmentRequired Boolean Always use segmentRequired:true.
schemaConfig.identityRequired Boolean Use true if you users should be able to map identity namespaces from Experience Platform to your desired schema.
aggregation.aggregationType - Select either BEST_EFFORT or CONFIGURABLE_AGGREGATION. The example configuration above includes BEST_EFFORT aggregation. For an example of CONFIGURABLE_AGGREGATION, refer to the example configuration in the destination configuration document. The parameters relevant to configurable aggregation are documented below in this table.
aggregation.bestEffortAggregation.maxUsersPerRequest Integer Experience Platform can aggregate multiple exported profiles in a single HTTP call. Specify the maximum number of profiles that your endpoint should receive in a single HTTP call. Note that this is a best effort aggregation. For example, if you specify the value 100, Platform might send any number of profiles smaller than 100 on a call.
If your server does not accept multiple users per request, set this value to 1.
aggregation.bestEffortAggregation.splitUserById Boolean Use this flag if the call to the destination should be split by identity. Set this flag to true if your server only accepts one identity per call, for a given namespace.
aggregation.configurableAggregation.splitUserById Boolean See parameter in example configuration here. Use this flag if the call to the destination should be split by identity. Set this flag to true if your server only accepts one identity per call, for a given namespace.
aggregation.configurableAggregation.maxBatchAgeInSecs Integer Maximum value: 3600. See parameter in example configuration here. Together with maxNumEventsInBatch, this determines how long Experience Platform should wait until sending an API call to your endpoint.
For example, if you use the maximum value for both parameters, Experience Platform will wait either 3600 seconds OR until there are 10.000 qualified profiles before making the API call, whichever happens first.
aggregation.configurableAggregation.maxNumEventsInBatch Integer Maximum value: 10000. See parameter in example configuration here. See maxBatchAgeInSecs just above.
aggregation.configurableAggregation.aggregationKey Boolean See parameter in example configuration here. Allows you to aggregate the exported profiles mapped to the destination based on the parameters below:
  • segment ID
  • segment status
  • identity namespace
aggregation.configurableAggregation.aggregationKey.includeSegmentId Boolean See parameter in example configuration here. Set this to true if you want to group profiles exported to your destination by segment ID.
aggregation.configurableAggregation.aggregationKey.includeSegmentStatus Boolean See parameter in example configuration here. You must set both includeSegmentId:true and includeSegmentStatus:true if you want to group profiles exported to your destination by segment ID AND segment status.
aggregation.configurableAggregation.aggregationKey.includeIdentity Boolean See parameter in example configuration here. Set this to true if you want to group profiles exported to your destination by identity namespace.
aggregation.configurableAggregation.aggregationKey.oneIdentityPerGroup Boolean See parameter in example configuration here. Use this parameter to specify if you want the exported profiles to be aggregated into groups of a single identity (GAID, IDFA, phone numbers, email, etc.).
aggregation.configurableAggregation.aggregationKey.groups String See parameter in example configuration here. Create lists of identity groups if you want to group profiles exported to your destination by groups of identity namespace. For example, you could combine profiles that contain the IDFA and GAID mobile identifiers into one call to your destination and emails into another by using the configuration in the example.

Response

A successful response returns HTTP status 200 with details of your newly created destination configuration.

List destination configurations

You can retrieve a list of all destination configurations for your IMS Organization by making a GET request to the /authoring/destinations endpoint.

API format

GET /authoring/destinations

Request

The following request will retrieve the list of destination configurations that you have access to, based on IMS Organization and sandbox configuration.

curl -X GET https://platform.adobe.io/data/core/activation/authoring/destinations \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Response

The following response returns HTTP status 200 with a list of destination configurations that you have access to, based on the IMS Organization ID and sandbox name that you used. One instanceId corresponds to the template for one destination. The response is truncated for brevity.


{
   "items":[
      {
         "instanceId":"b0780cb5-2bb7-4409-bf2c-c625ca818588",
         "createdDate":"2020-10-28T06:14:09.784471Z",
         "lastModifiedDate":"2021-06-28T06:14:09.784471Z",
         "imsOrg":"AC3428435BF324E90A49402A@AdobeOrg",
         "sandboxName":"prod",
         "sandboxId":"r5g6660-c5da-11e9-93d4-6d5fc3a66a8e",
         "name":"Moviestar",
         "description":"Moviestar is a fictional destination, used for this example.",
         "status":"TEST",
         "customerAuthenticationConfigurations":[
            {
               "authType":"BEARER"
            }
         ],
         "customerDataFields":[
            {
               "name":"endpointsInstance",
               "type":"string",
               "title":"Select Endpoint",
               "description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
               "isRequired":true,
               "enum":[
                  "US",
                  "EU",
                  "APAC",
                  "NZ"
               ]
            },
            {
               "name":"customerID",
               "type":"string",
               "title":"Moviestar Customer ID",
               "description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
               "isRequired":true,
               "pattern":"^[A-Za-z]+$"
            }
         ],
         "uiAttributes":{
            "documentationLink":"https://www.adobe.com/go/destinations-moviestar-en",
            "category":"mobile",
            "connectionType":"Server-to-server",
            "frequency":"Streaming"
         },
         "identityNamespaces":{
            "external_id":{
               "acceptsAttributes":true,
               "acceptsCustomNamespaces":true,
               "acceptedGlobalNamespaces":{
                  "Email":{
                     
                  }
               }
            },
            "another_id":{
               "acceptsAttributes":true,
               "acceptsCustomNamespaces":true
            }
         },
         "segmentMappingConfig":{
            "mapExperiencePlatformSegmentName":false,
            "mapExperiencePlatformSegmentId":false,
            "mapUserInput":false,
            "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
         },
         "schemaConfig":{
            "profileFields":[
               {
                  "name":"a_custom_attribute",
                  "title":"a_custom_attribute",
                  "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
                  "type":"string",
                  "isRequired":false,
                  "readOnly":false,
                  "hidden":false
               }
            ],
            "profileRequired":true,
            "segmentRequired":true,
            "identityRequired":true
         },
         "aggregation":{
            "aggregationType":"BEST_EFFORT",
            "bestEffortAggregation":{
               "maxUsersPerRequest":10,
               "splitUserById":false
            }
         },
         "destinationDelivery":[
            {
               "authenticationRule":"CUSTOMER_AUTHENTICATION",
               "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
            }
         ],
         "destConfigId":"410631b8-f6b3-4b7c-82da-7998aa3f327c",
         "backfillHistoricalProfileData":true
      }
   ]
}
    
Parameter Type Description
name String Indicates the title of your destination in the Experience Platform catalog.
description String Provide a description that Adobe will use in the Experience Platform destinations catalog for your destination card. Aim for no more than 4-5 sentences.
status String Indicates the lifecycle status of the destination card. Accepted values are TEST, PUBLISHED, and DELETED. Use TEST when you first configure your destination.
customerAuthenticationConfigurations String Indicates the configuration used to authenticate Experience Platform customers to your server. See authType below for accepted values.
customerAuthenticationConfigurations.authType String Accepted values are OAUTH2, BEARER.
customerDataFields.name String Provide a name for the custom field you are introducing.
customerDataFields.type String Indicates what type of custom field you are introducing. Accepted values are string, object, integer
customerDataFields.title String Indicates the name of the field, as it is seen by customers in the Experience Platform user interface
customerDataFields.description String Provide a description for the custom field.
customerDataFields.isRequired Boolean Indicates if this field is required in the destination setup workflow.
customerDataFields.enum String Renders the custom field as a dropdown menu and lists the options available to the user.
customerDataFields.pattern String Enforces a pattern for the custom field, if needed. Use regular expressions to enforce a pattern. For example, if your customer IDs don’t include numbers or underscores, enter ^[A-Za-z]+$ in this field.
uiAttributes.documentationLink String Refers to the documentation page in the Destinations Catalog for your destination. Use https://www.adobe.com/go/destinations-YOURDESTINATION-en, where YOURDESTINATION is the name of your destination. For a destination called Moviestar, you would use https://www.adobe.com/go/destinations-moviestar-en
uiAttributes.category String Refers to the category assigned to your destination in Adobe Experience Platform. For more information, read Destination Categories. Use one of the following values: adobeSolutions, advertising, analytics, cdp, cloudStorage, crm, customerSuccess, database, dmp, ecommerce, email, emailMarketing, enrichment, livechat, marketingAutomation, mobile, personalization, protocols, social, streaming, subscriptions, surveys, tagManagers, voc, warehouses, payments
uiAttributes.connectionType String Server-to-server is currently the only available option.
uiAttributes.frequency String Streaming is currently the only available option.
identityNamespaces.externalId.acceptsAttributes Boolean Indicates if your destination accepts standard profile attributes. Usually, these attributes are highlighted in our partners’ documentation.
identityNamespaces.externalId.acceptsCustomNamespaces Boolean Indicates if customers can set up custom namespaces in your destination. Read more about custom namespaces in Adobe Experience Platform.
identityNamespaces.externalId.allowedAttributesTransformation String Not shown in example configuration. Used, for example, when the Platform customer has plain email addresses as an attribute and your platform only accepts hashed emails. This is where you would provide the transformation that needs to be applied (for example, transform the email to lowercase, then hash).
identityNamespaces.externalId.acceptedGlobalNamespaces - Used for cases when your platform accepts standard identity namespaces (for example, IDFA), so you can restrict Platform users to only selecting these identity namespaces.
destinationDelivery.authenticationRule String Indicates how Platform customers connect to your destination. Accepted values are CUSTOMER_AUTHENTICATION, PLATFORM_AUTHENTICATION, NONE.
  • Use CUSTOMER_AUTHENTICATION if Platform customers log into your system via a username and password, a bearer token, or another method of authentication. For example, you would select this option if you also selected authType: OAUTH2 or authType:BEARER in customerAuthenticationConfigurations.
  • Use PLATFORM_AUTHENTICATION if there is a global authentication system between Adobe and your destination and the Platform customer does not need to provide any authentication credentials to connect to your destination. In this case, you must create a credentials object using the Credentials configuration.
  • Use NONE if no authentication is required to send data to your destination platform.
destinationDelivery.destinationServerId String The instanceId of the destination server template used for this destination.
destConfigId String This field is automatically generated and does not require your input.
backfillHistoricalProfileData Boolean Controls whether historical profile data is exported when segments are activated to the destination.
  • true: Platform sends the historical user profiles that qualified for the segment before the segment is activated.
  • false: Platform only includes user profiles that qualify for the segment after the segment is activated.
segmentMappingConfig.mapUserInput Boolean Controls whether the segment mapping id in the destination activation workflow is input by user.
segmentMappingConfig.mapExperiencePlatformSegmentId Boolean Controls whether the segment mapping id in the destination activation workflow is the Experience Platform segment ID.
segmentMappingConfig.mapExperiencePlatformSegmentName Boolean Controls whether the segment mapping id in the destination activation workflow is the Experience Platform segment name.
segmentMappingConfig.audienceTemplateId Boolean The instanceId of the audience metadata template used for this destination. To set up an audience metadata template, read the audience metadata API reference.

Update an existing destination configuration

You can update an existing destination configuration by making a PUT request to the /authoring/destinations endpoint and providing the instance ID of the destination configuration you want to update. In the body of the call, provide the updated destination configuration.

API format

PUT /authoring/destinations/{INSTANCE_ID}
Parameter Description
{INSTANCE_ID} The ID of the destination configuration that you want to update.

Request

The following request updates an existing destination configuration, configured by the parameters provided in the payload. In the example call below, we are updating the configuration created earlier to now accept GAID, IDFA, and hashed email identifiers as identity namespaces.


curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destinations/b0780cb5-2bb7-4409-bf2c-c625ca818588 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
   "instanceId":"b0780cb5-2bb7-4409-bf2c-c625ca818588",
   "createdDate":"2020-10-28T06:14:09.784471Z",
   "lastModifiedDate":"2021-04-28T06:14:09.784471Z",
   "imsOrg":"AC3428435BF324E90A49402A@AdobeOrg",
   "sandboxName":"prod",
   "sandboxId":"r5g6660-c5da-11e9-93d4-6d5fc3a66a8e",
   "name":"Moviestar",
   "description":"Moviestar is a fictional destination, used for this example.",
   "status":"TEST",
   "customerAuthenticationConfigurations":[
      {
         "authType":"BEARER"
      }
   ],
   "customerDataFields":[
      {
         "name":"endpointsInstance",
         "type":"string",
         "title":"Select Endpoint",
         "description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
         "isRequired":true,
         "enum":[
            "US",
            "EU",
            "APAC",
            "NZ"
         ]
      },
      {
         "name":"customerID",
         "type":"string",
         "title":"Moviestar Customer ID",
         "description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
         "isRequired":true,
         "pattern":"^[A-Za-z]+$"
      }
   ],
   "uiAttributes":{
      "documentationLink":"https://www.adobe.com/go/destinations-moviestar-en",
      "category":"mobile",
      "connectionType":"Server-to-server",
      "frequency":"Streaming"
   },
   "identityNamespaces":{
      "external_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "Email":{
            }
         }
      },
      "another_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true
      },
      "gaid":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "GAID":{
               
            }
         }
      },
      "idfa":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "IDFA":{
               
            }
         }
      },
      "email_lc_sha256":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "transformation":"sha256(lower($))",
         "acceptedGlobalNamespaces":{
            "Email":{
               "requiredTransformation":"sha256(lower($))"
            },
            "Email_LC_SHA256":{
               
            }
         }
      }
   },
   "segmentMappingConfig":{
      "mapExperiencePlatformSegmentName":false,
      "mapExperiencePlatformSegmentId":false,
      "mapUserInput":false,
      "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
   },
   "schemaConfig":{
      "profileFields":[
         {
            "name":"a_custom_attribute",
            "title":"a_custom_attribute",
            "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
            "type":"string",
            "isRequired":false,
            "readOnly":false,
            "hidden":false
         }
      ],
      "profileRequired":true,
      "segmentRequired":true,
      "identityRequired":true
   },
   "aggregation":{
      "aggregationType":"BEST_EFFORT",
      "bestEffortAggregation":{
         "maxUsersPerRequest":10,
         "splitUserById":false
      }
   },
   "destinationDelivery":[
      {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
      }
   ],
   "backfillHistoricalProfileData":true
}

Retrieve a specific destination configuration

You can retrieve detailed information about a specific destination configuration by making a GET request to the /authoring/destinations endpoint and providing the instance ID of the destination configuration you want to retrieve.

API format

GET /authoring/destinations/{INSTANCE_ID}
Parameter Description
{INSTANCE_ID} The ID of the destination configuration you want to retrieve.

Request

curl -X GET https://platform.adobe.io/data/core/activation/authoring/destinations/b0780cb5-2bb7-4409-bf2c-c625ca818588 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Response

A successful response returns HTTP status 200 with detailed information about the specified destination configuration.

{
   "instanceId":"b0780cb5-2bb7-4409-bf2c-c625ca818588",
   "createdDate":"2020-10-28T06:14:09.784471Z",
   "lastModifiedDate":"2021-06-04T06:14:09.784471Z",
   "imsOrg":"AC3428435BF324E90A49402A@AdobeOrg",
   "sandboxName":"prod",
   "sandboxId":"r5g6660-c5da-11e9-93d4-6d5fc3a66a8e",
   "name":"Moviestar",
   "description":"Moviestar is a fictional destination, used for this example.",
   "status":"TEST",
   "customerAuthenticationConfigurations":[
      {
         "authType":"BEARER"
      }
   ],
   "customerDataFields":[
      {
         "name":"endpointsInstance",
         "type":"string",
         "title":"Select Endpoint",
         "description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
         "isRequired":true,
         "enum":[
            "US",
            "EU",
            "APAC",
            "NZ"
         ]
      },
      {
         "name":"customerID",
         "type":"string",
         "title":"Moviestar Customer ID",
         "description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
         "isRequired":true,
         "pattern":"^[A-Za-z]+$"
      }
   ],
   "uiAttributes":{
      "documentationLink":"https://www.adobe.com/go/destinations-moviestar-en",
      "category":"mobile",
      "connectionType":"Server-to-server",
      "frequency":"Streaming"
   },
   "identityNamespaces":{
      "external_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "Email":{
               
            }
         }
      },
      "another_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true
      },
      "gaid":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "GAID":{
               
            }
         }
      },
      "idfa":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "IDFA":{
               
            }
         }
      },
      "email_lc_sha256":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "transformation":"sha256(lower($))",
         "acceptedGlobalNamespaces":{
            "Email":{
               "requiredTransformation":"sha256(lower($))"
            },
            "Email_LC_SHA256":{
               
            }
         }
      }
   },
   "segmentMappingConfig":{
      "mapExperiencePlatformSegmentName":false,
      "mapExperiencePlatformSegmentId":false,
      "mapUserInput":false,
      "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
   },
   "schemaConfig":{
      "profileFields":[
         {
            "name":"a_custom_attribute",
            "title":"a_custom_attribute",
            "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
            "type":"string",
            "isRequired":false,
            "readOnly":false,
            "hidden":false
         }
      ],
      "profileRequired":true,
      "segmentRequired":true,
      "identityRequired":true
   },
   "aggregation":{
      "aggregationType":"BEST_EFFORT",
      "bestEffortAggregation":{
         "maxUsersPerRequest":10,
         "splitUserById":false
      }
   },
   "destinationDelivery":[
      {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
      }
   ],
   "backfillHistoricalProfileData":true
}

Delete a specific destination configuration

You can delete the specified destination configuration by making a DELETE request to the /authoring/destinations endpoint and providing the ID of the destination configuration you wish to delete in the request path.

API format

DELETE /authoring/destinations/{INSTANCE_ID}
Parameter Description
{INSTANCE_ID} The id of the destination configuration you want to delete.

Request

curl -X DELETE https://platform.adobe.io/data/core/activation/authoring/destinations/b0780cb5-2bb7-4409-bf2c-c625ca818588 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \

Response

A successful response returns HTTP status 200 along with an empty HTTP response.

API error handling

Destination SDK API endpoints follow the general Experience Platform API error message principles. Refer to API status codes and request header errors in the Platform troubleshooting guide.

Next steps

After reading this document, you now know how to configure your destination using the /authoring/destinations API endpoint. Read how to use Destination SDK to configure your destination to understand where this step fits into the process of configuring your destination.

On this page