openapi: 3.2.0 info: description: "Adobe Experience Platform Destination SDK (also referred to as the *Destination Authoring API*) is a suite of configuration APIs that allow you to configure destination integration patterns for Experience Platform to deliver audience and profile data to your endpoint, based on data and authentication formats of your choice. \n- **Related documentation**:\n - [Destination SDK overview](http://www.adobe.com/go/destination-sdk-overview-en)\n - [Getting started](http://www.adobe.com/go/destination-sdk-getting-started-en)\n\n- **Visualize API calls with Postman (a free, third-party software)**:\n - [Destination Authoring API Postman collection on GitHub](https://github.com/adobe/experience-platform-postman-samples/blob/master/apis/experience-platform/Destination%20Authoring%20API.postman_collection.json)\n - [Video guide for creating the Postman environment](https://video.tv.adobe.com/v/28832)\n - [Steps for importing environments and collections in Postman](https://learning.postman.com/docs/getting-started/importing-and-exporting-data/)\n\n- **API paths**:\n - PLATFORM Gateway URL: https://platform.adobe.io\n - Base path for this API: /data/core/activation/authoring\n - Example of a complete path for making a call to \"/destinations\": https://platform.adobe.io/data/core/activation/authoring/destinations\n\n- **Required headers**:\n - All service calls require the headers `Authorization`, `x-gw-ims-org-id`, and `x-api-key`. For more information on how to obtain these values, see the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).\n - All resources in Experience Platform are isolated to specific virtual sandboxes. All requests to Platform APIs require the header `x-sandbox-name` whose value is the all-lowercase name of the sandbox the operation will take place in (for example, \"prod\"). See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.\n - All requests with a payload in the request body (such as POST, PUT, and PATCH calls) must include the header `Content-Type` with a value of `application/json`.\n\n- **API error handling**:\n - Refer to the Experience Platform API troubleshooting guide for [FAQs](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html?lang=en#faq), [API status codes](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html?lang=en#api-status-codes), and [request header errors](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html?lang=en#request-header-errors)." version: '1.0' title: Destination Authoring Destination configurations API servers: - url: https://platform.adobe.io/data/core/activation/authoring description: Production server tags: - name: Destination configurations description: Destination configurations contain essential metadata for individual destinations, including their name, category, description, and more. The settings in this configuration also determine how Experience Platform users authenticate to your destination, how it appears in the Experience Platform user interface, and the identities that can be exported to your destination.

For a description of the functionality supported by this endpoint and an example configuration, see the overview on [destination configurations](http://www.adobe.com/go/destination-sdk-destination-configuration-en) in the Destination SDK documentation. paths: /destinations: get: tags: - Destination configurations summary: Retrieve a list of destination configurations description: You can retrieve a list of all destination configurations for your IMS Organization by making a GET request to the `/destinations` endpoint. operationId: listDestinations parameters: - $ref: '#/components/parameters/authorization' - $ref: '#/components/parameters/x-api-key' - $ref: '#/components/parameters/x-gw-ims-org-id' - $ref: '#/components/parameters/x-sandbox-name' responses: '200': description: A successful response returns HTTP status 200 with a list of destination configurations that you have access to, based on the IMS Org ID and sandbox name that you used. One instanceId corresponds to one destination configuration. x-summary: Destination configurations retrieved successfully content: application/json: schema: type: array items: $ref: '#/components/schemas/destinationResponse' examples: default: value: 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 '401': description: Unauthorized. A mandatory header might be missing from the request or you may be missing permissions to access the resource. Verify your request and try again. x-summary: Unauthorized access '403': description: Forbidden. The requester is not authorized to access the resource or a mandatory header might be missing from the request. Verify your request and try again. x-summary: Access forbidden post: tags: - Destination configurations summary: Create a destination configuration description: You can create a new destination configuration by making a POST request to the `/destinations` endpoint.

The payload below includes all parameters for file-based destinations accepted by the `/authoring/destinations` endpoint. Note that you do not have to add all parameters to your API call, and that the payload is customizable, according to your API requirements. operationId: createDestination parameters: - $ref: '#/components/parameters/authorization' - $ref: '#/components/parameters/x-api-key' - $ref: '#/components/parameters/x-gw-ims-org-id' - $ref: '#/components/parameters/x-sandbox-name' requestBody: description: Destination configuration object for a new destination. The request creates an Amazon S3 destination configuration, configured by the parameters provided in the payload. The payload below includes all parameters for file-based destinations accepted by the `/authoring/destinations` endpoint. Note that you do not have to add all parameters to your API call, and that the payload is customizable, according to your API requirements.

Refer to the Destination SDK documentation for an example of a destination configuration for a [file-based](https://experienceleague.adobe.com/en/docs/experience-platform/destinations/destination-sdk/guides/configure-file-based-destination-instructions#create-destination-configuration) and a [streaming destination](https://experienceleague.adobe.com/en/docs/experience-platform/destinations/destination-sdk/guides/configure-destination-instructions#create-destination-configuration). required: true content: application/json: schema: $ref: '#/components/schemas/destination' responses: '200': description: A successful response returns HTTP status 200 with details of your newly created destination configuration. x-summary: Destination configuration created content: application/json: schema: $ref: '#/components/schemas/destinationResponse' '400': description: Bad request. The request payload was incorrectly formatted. Check your payload formatting before trying again. x-summary: Bad request due to incorrect payload format '401': description: Unauthorized. A mandatory header might be missing from the request or you may be missing permissions to access the resource. Verify your request and try again. x-summary: Unauthorized access '403': description: Forbidden. The requester is not authorized to access the resource or a mandatory header might be missing from the request. Verify your request before trying again. x-summary: Access forbidden /destinations/{INSTANCE_ID}: get: tags: - Destination configurations summary: Retrieve a destination configuration description: You can retrieve detailed information about a specific destination configuration by making a GET request to the `/destinations` endpoint and providing the ID of the destination configuration you want to retrieve. operationId: retrieveDestination parameters: - $ref: '#/components/parameters/authorization' - $ref: '#/components/parameters/x-api-key' - $ref: '#/components/parameters/x-gw-ims-org-id' - $ref: '#/components/parameters/x-sandbox-name' - name: INSTANCE_ID in: path description: The ID of the destination configuration that you want to retrieve. required: true schema: type: string responses: '200': description: A successful response returns HTTP status 200 with the details of the destination configuration corresponding to the INSTANCE_ID provided in the call. x-summary: Destination configuration retrieved content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/destinationResponse' examples: default: value: 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 '400': description: Bad request. The request payload was incorrectly formatted. Check your payload formatting before trying again. x-summary: Bad request due to formatting error '401': description: Unauthorized. A mandatory header might be missing from the request or you may be missing permissions to access the resource. Verify your request before trying again. x-summary: Unauthorized access '403': description: Forbidden. The requester is not authorized to access the resource or a mandatory header might be missing from the request. Verify your request before trying again. x-summary: Access forbidden '404': description: Resource not found. Verify that you are using the correct destination configuration ID before trying again. x-summary: Resource not found put: tags: - Destination configurations summary: Update a destination configuration description: You can update an existing destination configuration by making a PUT request to the `/destinations` endpoint with the updated payload.

To obtain an existing destination configuration and its corresponding `{INSTANCE_ID}`, see [Retrieve a destination configuration](#operation/retrieveDestination). operationId: updateDestination parameters: - $ref: '#/components/parameters/authorization' - $ref: '#/components/parameters/x-api-key' - $ref: '#/components/parameters/x-gw-ims-org-id' - $ref: '#/components/parameters/x-sandbox-name' - name: INSTANCE_ID in: path description: The ID of the destination configuration that you want to update. To obtain an existing destination configuration and its corresponding `{INSTANCE_ID}`, see [Retrieve a destination configuration](#operation/retrieveDestination). required: true schema: type: string requestBody: description: Destination configuration object to update existing destination. The request updates the destination configuration with the parameters provided in the payload. See an example of a destination configuration for a [file-based](https://experienceleague.adobe.com/en/docs/experience-platform/destinations/destination-sdk/guides/configure-file-based-destination-instructions#create-destination-configuration) and a [streaming destination](https://experienceleague.adobe.com/en/docs/experience-platform/destinations/destination-sdk/guides/configure-destination-instructions#create-destination-configuration). required: true content: application/json: schema: $ref: '#/components/schemas/destination' responses: '200': description: A successful response returns HTTP status 200 with the details of your updated destination configuration. x-summary: Destination configuration updated content: application/json: schema: $ref: '#/components/schemas/destinationResponse' '400': description: Bad request. The request payload was incorrectly formatted. Check your payload formatting before trying again. x-summary: Bad request due to incorrect formatting '401': description: Unauthorized. A mandatory header might be missing from the request or you may be missing permissions to access the resource. Verify your request and try again. x-summary: Unauthorized access '403': description: Forbidden. The requester is not authorized to access the resource or a mandatory header might be missing from the request. Verify your request before trying again. x-summary: Access forbidden '404': description: Resource not found. Verify that you are using the correct destination configuration ID before trying again. x-summary: Resource not found delete: tags: - Destination configurations summary: Delete a destination configuration description: You can delete an existing destination configuration by making a DELETE request to the `/destinations` endpoint with the `{INSTANCE_ID}` of the destination configuration that you want to delete.

To obtain an existing destination configuration and its corresponding `{INSTANCE_ID}`, see [Retrieve a destination configuration](#operation/retrieveDestination). operationId: deleteDestination parameters: - $ref: '#/components/parameters/authorization' - $ref: '#/components/parameters/x-api-key' - $ref: '#/components/parameters/x-gw-ims-org-id' - $ref: '#/components/parameters/x-sandbox-name' - name: INSTANCE_ID in: path description: The ID of the destination configuration you want to delete. required: true schema: type: string responses: '200': description: A successful response returns HTTP status 200 along with an empty HTTP response. x-summary: Resource deleted successfully '401': description: Unauthorized. A mandatory header might be missing from the request or you may be missing permissions to access the resource. Verify your request and try again. x-summary: Unauthorized access '403': description: Forbidden. The requester is not authorized to access the resource or a mandatory header might be missing from the request. Verify your request before trying again. x-summary: Access forbidden '404': description: Resource not found. Verify that you are using the correct destination configuration ID before trying again. x-summary: Resource not found components: schemas: destinationResponse: allOf: - $ref: '#/components/schemas/response' - $ref: '#/components/schemas/destination' customerDataField: type: object properties: name: type: string example: endpointsInstance description: Provide a name for the custom field you are introducing. type: type: string example: string description: Indicates what type of custom field you are introducing. Accepted values are string, object, integer. enum: - string - object - integer title: type: string example: Select endpoint description: Indicates the name of the field, as it is seen by customers in the Experience Platform user interface. description: type: string example: Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list. description: Provide a description for the custom field. isRequired: type: boolean example: true description: Indicates if this field is required in the destination setup workflow. default: type: object enum: type: array example: - US - EU - APAC - NZ description: Renders the custom field as a dropdown menu and lists the options available to the user. items: type: object pattern: type: string example: ^[A-Za-z]+$ description: 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. format: type: string example: password description: The format associated with the data. If you use `password` as format, Experience Platform will automatically treat the data field value as sensitive information and encrypt it. destinationDeliveryItem: type: object description: Settings related how customers authenticate to your destination. properties: authenticationRule: type: string example: CUSTOMER_AUTHENTICATION title: Authentication Rule description: 'Indicates how Experience Platform customers connect to your destination.

' enum: - CUSTOMER_AUTHENTICATION - PLATFORM_AUTHENTICATION - NONE authenticationId: type: string description: The `instanceId` of the credentials configuration object to use for authentication. This parameter is required when using `PLATFORM_AUTHENTICATION` to link your destination configuration to the credentials configuration. When using `CUSTOMER_AUTHENTICATION`, this parameter is not needed. destinationServerId: type: string example: 2307ec2b-4798-45a4-9239-5d0a2fb0ed67 description: The `instanceId` of the destination server configuration used for this destination. identityNamespaces: type: object title: Identity Namespaces description: List of allowed identity namespaces. additionalProperties: $ref: '#/components/schemas/identityNamespace' configurableAggregation: title: Configurable Aggregation description: Required parameters to set up configurable aggregation. type: object properties: splitUserById: type: boolean example: false description: 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. maxBatchAgeInSecs: type: integer example: 3000 description: '' maxNumEventsInBatch: type: integer example: 5000 description: ' ' aggregationKey: type: object description: 'Allows you to aggregate the exported profiles mapped to the destination based on the parameters below: 1.segment ID, 2.segment status,3. identity namespace.' properties: includeSegmentId: type: boolean example: true description: Set this to true if you want to group profiles exported to your destination by segment ID. includeSegmentStatus: type: boolean example: true description: 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. includeIdentity: type: boolean example: true description: Set this to true if you want to group profiles exported to your destination by identity namespace. oneIdentityPerGroup: type: boolean example: false description: 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.) groups: type: array description: 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. items: $ref: '#/components/schemas/IdentityGroup' IdentityGroup: type: object example: - namespaces: - IDFA - GAID - namespaces: - EMAIL properties: namespaces: type: array items: type: string customerAuthenticationConfiguration: type: object discriminator: propertyName: authType properties: authType: title: Customer Authentication Type example: BEARER description: Defines Customer Authentication type. type: string enum: - S3 - SFTP_WITH_SSH_KEY - SFTP_WITH_PASSWORD - OAUTH1 - OAUTH2 - BASIC - BEARER options: type: object additionalProperties: {} required: - authType identityNamespace: type: object properties: acceptsAttributes: type: boolean example: 'true' description: Indicates if customers can map standard profile attributes to the identity that you are configuring. acceptsCustomNamespaces: type: boolean example: 'true' description: Indicates if customers can map identities belonging to [custom namespaces](https://experienceleague.adobe.com/docs/experience-platform/identity/namespaces.html?lang=en#manage-namespaces) to the identity that you are configuring. transformation: type: string description: 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). acceptedGlobalNamespaces: type: object example: Email: {} IDFA: {} description: 'Indicates which [standard identity namespaces](https://experienceleague.adobe.com/docs/experience-platform/identity/namespaces.html?lang=en#standard-namespaces) (for example: IDFA, GAID, Email) customers can map to the identity that you are configuring.
When you use `acceptedGlobalNamespaces`, you can use `requiredTransformation:sha256(lower($))` to lowercase and hash email addresses or phone numbers.' additionalProperties: type: object properties: requiredTransformation: type: string example: sha256(lower($)) description: Indicates how values should be transformed. For example, use `requiredTransformation:sha256(lower($))`` to lowercase and hash email addresses or phone numbers. response: properties: instanceId: type: string example: 2307ec2b-4798-45a4-9239-5d0a2fb0ed67 title: Instance ID description: The unique ID of an object. createdDate: type: string example: '2020-11-17T06:49:24.331012Z' title: Created date description: Created date in UTC. lastModifiedDate: type: string example: '2020-11-17T06:49:24.331012Z' title: Last modified date description: Last update date in UTC. destination: properties: name: type: string example: Moviestar configuration title: Name description: Indicates the title of your destination in the Experience Platform catalog. description: type: string example: Moviestar is a fictional destination, used for this example. title: Internal Description description: 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: type: string example: TEST title: Status description: Indicates the lifecycle status of the destination card. Use `TEST` when you first configure your destination. enum: - TEST - PUBLISHED - DELETED customerAuthenticationConfigurations: type: array title: Customer Authentication Configurations description: Indicates the configuration used to authenticate Experience Platform customers to your server. See `authType` below for accepted values. items: $ref: '#/components/schemas/customerAuthenticationConfiguration' customerDataFields: type: array description: Defines fields that you are requiring the Experience Platform customer to fill in when they set up a connection to your destination. items: $ref: '#/components/schemas/customerDataField' uiAttributes: type: object description: Provide values for the parameters in this object to set up various UI elements for your destination. properties: documentationLink: type: string example: https://www.adobe.com/go/destinations-moviestar-en description: Refers to the documentation page in the Destinations Catalog for your destination. Use http://www.adobe.com/go/destinations-YOURDESTINATION-en, where YOURDESTINATION is the name of your destination. For a destination called Moviestar, you would use `http://www.adobe.com/go/destinations-moviestar-en` category: type: string example: mobile description: Refers to the category assigned to your destination in Adobe Experience Platform. For more information, read [Destination categories](http://www.adobe.com/go/destinations-types-categories-en). enum: - 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 connectionType: type: string example: Server-to-server default: Server-to-server description: '`Server-to-server` is currently the only available option.' enum: - Server-to-server - Cloud Storage frequency: type: string example: Streaming description: '`Streaming` is currently the only available option.' enum: - Streaming - Batch identityNamespaces: $ref: '#/components/schemas/identityNamespaces' destinationDelivery: type: array items: $ref: '#/components/schemas/destinationDeliveryItem' schemaConfig: type: object title: Schema Config description: The parameters in this object create your partner schema configuration. Read more about [schema configuration](https://experienceleague.adobe.com/en/docs/experience-platform/destinations/destination-sdk/functionality/destination-configuration/schema-configuration). properties: profileFields: type: array description: When you add predefined `profileFields` as shown in the [example configuration here](https://experienceleague.adobe.com/docs/experience-platform/destinations/destination-sdk/api-reference/destination-configuration-api.html?lang=en#create), users will have the option of mapping Experience Platform attributes to the predefined attributes on your destination's side. items: $ref: '#/components/schemas/customerDataField' profileRequired: type: boolean example: true title: Is Profile Required description: 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. segmentRequired: type: boolean example: true title: Is Segment Required description: Indicates if segment mappings are required. Always use `segmentRequired:true`. identityRequired: type: boolean example: true title: Is Identity Required description: Use true if you users should be able to map identity namespaces from Experience Platform to your desired schema. segmentNamespaceAllowList: type: array example: - AudienceManager title: Segment Namespace Allow List description: Allows users to map only audiences from the audience namespaces defined in the array to the destination.

Use of this parameter is discouraged in most cases. Instead, use `"segmentNamespaceDenyList":[]` to allow all types of audiences to be exported to your destination.

If both `segmentNamespaceAllowList` and `segmentNamespaceDenyList` are missing from your configuration, users will only be able to export audiences originating from the [Segmentation Service](https://experienceleague.adobe.com/en/docs/experience-platform/segmentation/home).

`segmentNamespaceAllowList` and `segmentNamespaceDenyList` are mutually exclusive. segmentNamespaceDenyList: type: array example: - AudienceManager title: Segment Namespace Deny List description: Restricts users from mapping audiences from the audience namespaces defined in the array to the destination.

Adobe recommends to allow the export of all audiences, regardless of the origin, by setting "segmentNamespaceDenyList":[].

**Important:** If you don't specify `segmentNamespaceDenyList` in your `schemaConfig` and you don't use `segmentNamespaceAllowList`, the system automatically sets `segmentNamespaceDenyList` to `[]`. This prevents the loss of custom audiences in the future. For safety, Adobe recommends explicitly setting `"segmentNamespaceDenyList":[]` in your configuration.

`segmentNamespaceAllowList` and `segmentNamespaceDenyList` are mutually exclusive. aggregation: type: object title: Aggregation Policy description: Indicates the aggregation policy that should be applied when Experience Platform exports data to your destination. Read more about [aggregation policies](https://experienceleague.adobe.com/en/docs/experience-platform/destinations/destination-sdk/functionality/destination-configuration/aggregation-policy). properties: aggregationType: type: string example: CONFIGURABLE_AGGREGATION description: Select either `BEST_EFFORT` or `CONFIGURABLE_AGGREGATION`. You are required to select one of them for your destination. enum: - BEST_EFFORT - CONFIGURABLE_AGGREGATION bestEffortAggregation: type: object title: Best Effort Aggregation description: Required parameters to set up best effort aggregation. properties: maxUsersPerRequest: type: integer example: '10' title: maxUsersPerRequest description: 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. splitUserById: type: boolean example: false title: splitUserById description: 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. configurableAggregation: type: object title: Configurable Aggregation description: Required parameters to set up configurable aggregation. $ref: '#/components/schemas/configurableAggregation' marketingActions: type: array title: Marketing Actions example: EMAIL_TARGETING description: Select if you want your destination to have default marketing actions. Read more about marketing actions in the [Data usage policies overview](http://www.adobe.com/go/dule-policies-en). items: type: string enum: - ANALYTICS - COMBINE_WITH_PII - CROSS_SITE_TARGETING - DATA_SCIENCE - EMAIL_TARGETING - EXPORT_TO_THIRD_PARTY - ONSITE_ADVERTISING - ONSITE_PERSONALIZATION - SINGLE_IDENTITY_PERSONALIZATION duleLabels: type: array title: DULE Labels example: C1 description: Select if you want your destination to have default data usage labels. Read more in the [Data usage labels glossary](http://www.adobe.com/go/dule-supported-labels-en). items: type: string enum: - C1 - C2 - C3 - C4 - C5 - C6 - C7 - C8 - C9 - C10 - I1 - I2 - S1 - S2 backfillHistoricalProfileData: type: boolean example: 'true' title: Historical profile data backfill description: Controls whether historical profile data is exported when segments are activated to the destination. default: true segmentMappingConfig: type: object description: The settings in this object determine how segments from Experience Platform are mapped to corresponding segments or audiences in your destination. properties: mapUserInput: type: boolean example: false default: false description: Controls whether the segment mapping ID in the destination activation workflow is input by the user. mapExperiencePlatformSegmentId: type: boolean example: false default: false description: Controls whether the segment mapping ID in the destination activation workflow is the Experience Platform segment ID. mapExperiencePlatformSegmentName: type: boolean example: false default: false description: Controls whether the segment mapping ID in the destination activation workflow is the Experience Platform segment name. audienceTemplateId: type: string example: 12a3238f-b509-4a40-b8fb-0a5006e7901d description: ' The `instanceId` of the [audience metadata template](http://www.adobe.com/go/destination-sdk-audience-metadata-en) used for this destination. When used, this controls whether the segment mapping ID is generated by audience metadata template.' batchConfiguration: type: object title: Batch Configuration description: Configuration settings for batch processing in file-based destinations. This object controls how data is processed and delivered in batch mode. properties: allowMandatoryFieldSelection: type: boolean example: true default: false title: Allow Mandatory Field Selection description: Set to `true` to allow customers to specify which profile attributes are mandatory. Default value is `false`. See [Mandatory attributes](https://experienceleague.adobe.com/en/docs/experience-platform/destinations/ui/activate/activate-batch-profile-destinations#mandatory-attributes) for more information. allowDedupeKeyFieldSelection: type: boolean example: true default: false title: Allow Dedupe Key Field Selection description: Set to `true` to allow customers to specify deduplication keys. Default value is `false`. See [Deduplication keys](https://experienceleague.adobe.com/en/docs/experience-platform/destinations/ui/activate/activate-batch-profile-destinations#deduplication-keys) for more information. defaultExportMode: type: string example: DAILY_FULL_EXPORT title: Default Export Mode description: 'Defines the default file export mode. Supported values: `DAILY_FULL_EXPORT`, `FIRST_FULL_THEN_INCREMENTAL`. Default value is `DAILY_FULL_EXPORT`. See the [batch activation documentation](https://experienceleague.adobe.com/en/docs/experience-platform/destinations/ui/activate/activate-batch-profile-destinations#scheduling) for details about file exports scheduling.' enum: - DAILY_FULL_EXPORT - FIRST_FULL_THEN_INCREMENTAL allowedExportModes: type: array title: Allowed Export Modes description: 'Defines the file export modes available to customers. Supported values: `DAILY_FULL_EXPORT`, `FIRST_FULL_THEN_INCREMENTAL`.' items: type: string enum: - DAILY_FULL_EXPORT - FIRST_FULL_THEN_INCREMENTAL allowedScheduleFrequency: type: array title: Allowed Schedule Frequency description: 'Defines the file export frequency available to customers. Supported values: `ONCE`, `EVERY_3_HOURS`, `EVERY_6_HOURS`, `EVERY_8_HOURS`, `EVERY_12_HOURS`, `DAILY`, `WEEKLY`, `MONTHLY`.' items: type: string enum: - ONCE - EVERY_3_HOURS - EVERY_6_HOURS - EVERY_8_HOURS - EVERY_12_HOURS - DAILY - WEEKLY - MONTHLY defaultFrequency: type: string example: DAILY title: Default Frequency description: 'Defines the default file export frequency. Supported values: `ONCE`, `EVERY_3_HOURS`, `EVERY_6_HOURS`, `EVERY_8_HOURS`, `EVERY_12_HOURS`, `DAILY`, `WEEKLY`, `MONTHLY`. Default value is `DAILY`.' enum: - ONCE - EVERY_3_HOURS - EVERY_6_HOURS - EVERY_8_HOURS - EVERY_12_HOURS - DAILY - WEEKLY - MONTHLY defaultStartTime: type: string example: 00:00 title: Default Start Time description: Defines the default start time for the file export. Uses 24-hour file format. Default value is "00:00". filenameConfig: type: object title: Filename Configuration description: Configuration for file naming options in batch exports. properties: allowedFilenameAppendOptions: type: array title: Allowed Filename Append Options description: 'List of available file name macros for users to choose from. This determines which items are appended to exported file names (audience ID, organization name, date and time of export, and others). When setting `defaultFilename`, make sure to avoid duplicating macros. Supported values: `DESTINATION`, `SEGMENT_ID`, `SEGMENT_NAME`, `DESTINATION_INSTANCE_ID`, `DESTINATION_INSTANCE_NAME`, `ORGANIZATION_NAME`, `SANDBOX_NAME`, `DATETIME`, `CUSTOM_TEXT`. Regardless of the order in which you define the macros, the Experience Platform UI will always display them in the order presented here. If `defaultFilename` is empty, the `allowedFilenameAppendOptions` list must contain at least one macro.' items: type: string enum: - DESTINATION - SEGMENT_ID - SEGMENT_NAME - DESTINATION_INSTANCE_ID - DESTINATION_INSTANCE_NAME - ORGANIZATION_NAME - SANDBOX_NAME - DATETIME - CUSTOM_TEXT - TIMESTAMP - MERGE_POLICY_ID - MERGE_POLICY_NAME defaultFilenameAppendOptions: type: array title: Default Filename Append Options description: Pre-selected default file name macros that users can uncheck. The macros in this list are a subset of the ones defined in `allowedFilenameAppendOptions`. items: type: string enum: - DESTINATION - SEGMENT_ID - SEGMENT_NAME - DESTINATION_INSTANCE_ID - DESTINATION_INSTANCE_NAME - ORGANIZATION_NAME - SANDBOX_NAME - DATETIME - CUSTOM_TEXT - TIMESTAMP - MERGE_POLICY_ID - MERGE_POLICY_NAME defaultFilename: type: string example: '%DESTINATION%_%SEGMENT_ID%' title: Default Filename description: Defines the default file name macros for the exported files. These cannot be overwritten by users. Any macro defined by `allowedFilenameAppendOptions` will be appended after the `defaultFilename` macros. If `defaultFilename` is empty, you must define at least one macro in `allowedFilenameAppendOptions`. required: - allowedFilenameAppendOptions - defaultFilenameAppendOptions segmentGroupingEnabled: type: boolean example: true title: Segment Grouping Enabled description: 'Defines whether the activated audiences should be exported in a single file or multiple files, based on audience [merge policy](https://experienceleague.adobe.com/en/docs/experience-platform/profile/merge-policies/overview). Supported values: `true` exports one file per merge policy, `false` exports one file per audience, regardless of the merge policy. This is the default behavior. You can achieve the same result by omitting this parameter entirely.' parameters: authorization: name: Authorization description: The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the [getting started tutorial](http://www.adobe.com/go/destination-sdk-getting-started-en). required: true schema: type: string in: header x-api-key: name: x-api-key description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [getting started tutorial](http://www.adobe.com/go/destination-sdk-getting-started-en). required: true schema: type: string in: header x-gw-ims-org-id: name: x-gw-ims-org-id description: The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [getting started tutorial](http://www.adobe.com/go/destination-sdk-getting-started-en). required: true schema: type: string in: header x-sandbox-name: name: x-sandbox-name description: The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information. For more information on how to obtain this value, visit the [getting started tutorial](http://www.adobe.com/go/destination-sdk-getting-started-en) required: true schema: type: string in: header