Adobe Suite Dataflows API

Destination dataflows represent the data transfer between a source connection (Experience Platform) and a target connection (the destination you set up). This also includes information regarding the data export schedule, and the transformation specifications of the data being exported to your destination. A dataflow instance is specific to a tenant and organization.

Operations 5

GET /flows Retrieve a list of destination dataflows #
POST /flows Create a destination dataflow #
GET /flows/{id} Retrieve a destination dataflow's details #
PATCH /flows/{id} Update a destination dataflow #
DELETE /flows/{id} Delete a destination dataflow #

Documentation

📖
Documentation
https://developer.adobe.com/photoshop/api/docs/
📖
Authentication
https://developer.adobe.com/developer-console/docs/guides/authentication/
📖
Documentation
https://developer.adobe.com/lightroom/api/docs/
📖
Documentation
https://developer.adobe.com/illustrator/api/docs/
📖
Documentation
https://developer.adobe.com/indesign/docs/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-extract-api/
📖
GettingStarted
https://developer.adobe.com/document-services/docs/overview/pdf-extract-api/gettingstarted/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-accessibility-auto-tag-api/
📖
Documentation
https://developer.adobe.com/analytics-apis/docs/
📖
APIReference
https://developer.adobe.com/analytics-apis/docs/2.0/
📖
Documentation
https://developer.adobe.com/firefly-services/docs/
📖
APIReference
https://developer.adobe.com/firefly-services/docs/api/
📖
Documentation
https://developer.adobe.com/audio-video-firefly-services/
📖
GettingStarted
https://developer.adobe.com/audio-video-firefly-services/getting-started/
📖
Documentation
https://developer.adobe.com/creative-cloud-libraries/docs/
📖
APIReference
https://developer.adobe.com/creative-cloud-libraries/docs/api/
📖
Documentation
https://developer.adobe.com/express/embed-sdk/docs/guides/
📖
APIReference
https://developer.adobe.com/express/embed-sdk/docs/v4/
📖
GettingStarted
https://developer.adobe.com/express/embed-sdk/docs/guides/quickstart/
📖
Documentation
https://developer.adobe.com/experience-platform-apis/
📖
GettingStarted
https://experienceleague.adobe.com/en/docs/experience-platform/landing/platform-apis/api-guide
📖
Documentation
https://developer.adobe.com/marketo-apis/
📖
Authentication
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/authentication
📖
Documentation
https://developer.adobe.com/commerce/docs/
📖
GettingStarted
https://developer.adobe.com/commerce/webapi/get-started/
📖
Documentation
https://developer.adobe.com/experience-cloud/cloud-manager/
📖
Documentation
https://developer.adobe.com/journey-optimizer-apis/
📖
Documentation
https://developer.adobe.com/workfront-apis/
📖
Documentation
https://developer.adobe.com/firefly-services/docs/substance3d/
📖
Documentation
https://developer.adobe.com/data-collection-apis/
📖
Documentation
https://developer.adobe.com/adobe-status/
📖
Documentation
https://developer.adobe.com/vip-marketplace/

Specifications

Other Resources

🔗
Pricing
https://developer.adobe.com/document-services/pricing/
🔗
SDKs
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/sdks/
🔗
ReleaseNotes
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/releasenotes
🔗
Guides
https://developer.adobe.com/analytics-apis/docs/2.0/guides/
🔗
Guides
https://developer.adobe.com/firefly-services/docs/guides/
🔗
Usage Notes
https://developer.adobe.com/audio-video-firefly-services/getting_started/usage/
🔗
Overview
https://developer.adobe.com/creative-cloud-libraries/docs/overview/
🔗
Integration Guide
https://developer.adobe.com/creative-cloud-libraries/docs/integrate/
🔗
API Fundamentals
https://experienceleague.adobe.com/en/docs/experience-platform/landing/platform-apis/api-fundamentals
🔗
Developer Guide
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/home
🔗
REST API
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/rest-api
🔗
REST API
https://developer.adobe.com/commerce/webapi/rest/
🔗
GraphQL API
https://developer.adobe.com/commerce/webapi/graphql-api/
🔗
REST API Reference
https://developer.adobe.com/commerce/webapi/reference/rest/paas/
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/graphql/adobe-suite-graphql.md
🔗
Webhooks
https://developer.adobe.com/experience-cloud/cloud-manager/guides/getting-started/create-event-integration/
🔗
StatusPage
https://status.adobe.com/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/adobe-suite-dataflows-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

adobe-suite-dataflows-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: "Use the Adobe Experience Platform Flow Service API to connect and activate data to various destinations within and outside of Adobe Experience Platform. This API reference is centered on exporting data to batch destinations like Amazon S3, SFTP, Azure Blob.\n>**NOTE**: Refer to [Flow Service API - Sources](https://developer.adobe.com/experience-platform-apis/references/flow-service/) if you are looking for API documentation to perform operations on *sources* in Experience Platform.\n- **Related documentation**:\n    - [Destinations overview](http://www.adobe.com/go/destinations-overview-en)\n    - [Activate data to file-based destinations - API tutorial](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/activate-segments-file-based-destinations.html)\n    - [Activate data to streaming destinations - API tutorial](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/streaming-destinations.html)\n    - [Update destination dataflows - API tutorial](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/update-destination-dataflows.html)\n    - [Export datasets - API tutorial](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/export-datasets.html)\n\n- **API paths**:\n  - PLATFORM Gateway URL: https://<span>platform.adobe.io/\n  - Base path for this API: /data/foundation/flowservice\n  - Example of a complete path: https://<span>platform.adobe.io/data/foundation/flowservice/flows\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#faq), [API status codes](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#api-status-codes), and [request header errors](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#request-header-errors). You can also view a list of [common Flow Service error messages](https://experienceleague.adobe.com/docs/experience-platform/sources/errors/flow-service-errors.html) and resolution suggestions.\n\n\n- **Sorting and filtering responses**:\n    - When performing listing (GET) requests in the Flow Service API, you can use query parameters to [sort and filter responses](https://experienceleague.adobe.com/docs/experience-platform/dataflows/api/sort-and-filter.html)."
  title: Flow Service API - Destinations Dataflows API
  version: 1.0.0
servers:
- url: https://{environment}.adobe.io/data/foundation/flowservice
  description: Adobe IO gateway endpoint
  variables:
    environment:
      default: platform
      enum:
      - platform
      - platform-stage
tags:
- name: Dataflows
  description: Destination dataflows represent the data transfer between a source connection (Experience Platform) and a target connection (the destination you set up). This also includes information regarding the data export schedule, and the transformation specifications of the data being exported to your destination. A dataflow instance is specific to a tenant and organization.
paths:
  /flows:
    get:
      tags:
      - Dataflows
      summary: Retrieve a list of destination dataflows
      description: 'You can retrieve a list of all destination dataflows for your organization by making a GET request to the `/flows` endpoint.  When performing listing (GET) requests in the Flow Service API, you can use query parameters to [sort and filter responses](https://experienceleague.adobe.com/docs/experience-platform/dataflows/api/sort-and-filter.html). <br><br> Use `isDestinationFlow` as query parameter  to return destination dataflows only, like this: `https://platform.adobe.io/data/foundation/flowservice/flows?property=inheritedAttributes.properties.isDestinationFlow==true` <br><br> Additionally, you can use query parameters to return only the dataflows for a <i>specific</i> destination. To do this, pass in the `connectionSpec.id` of the desired destination by using the `property` query parameter, as shown further below. See also the list of `connectionSpec` IDs for the most commonly used batch destinations: <br><ul><li>Adobe Campaign: `0b23e41a-cb4a-4321-a78f-3b654f5d7d97`</li><li>Amazon S3: `4fce964d-3f37-408f-9778-e597338a21ee`</li><li>Azure Blob Storage: `6d6b59bf-fb58-4107-9064-4d246c0e5bb2`</li><li>Azure Data Lake Gen 2(ADLS Gen2): `be2c3209-53bc-47e7-ab25-145db8b873e1`</li><li>Data Landing Zone(DLZ): `10440537-2a7b-4583-ac39-ed38d4b848e8`</li><li>Google Cloud Storage: `c5d93acb-ea8b-4b14-8f53-02138444ae99`</li><li>Oracle Eloqua: `c1e44b6b-e7c8-404b-9031-58f0ef760604`</li><li>Oracle Responsys: `a5e28ddf-e265-426e-83a1-9d03a3a6822b`</li><li>Salesforce Marketing Cloud: `f599a5b3-60a7-4951-950a-cc4115c7ea27`</li><li>SFTP: `36965a81-b1c6-401b-99f8-22508f1e6a26`</li></ul>

        >**NOTE**: This operation allows you to retrieve a maximum of 100 entities. The most recently created or updated entities are returned first. Use filters to return the dataflows that are most relevant to you.

        '
      operationId: getFlows
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XApiKey'
      - $ref: '#/components/parameters/XImsOrgId'
      - $ref: '#/components/parameters/XSandboxId'
      - $ref: '#/components/parameters/Accept'
      - in: query
        name: property
        description: 'A comma-separated list of top-level object properties to be returned in the response.  Used to cut down the amount of data returned in the response body. For example, `property=id==3416976c-a9ca-4bba-901a-1f08f66978ff,6a8d82b-1caf-45d1-908d-cadabc9d63a6,3c9b37f8-13a6-43d8-bad3-b863b941fedd`.

          '
        required: false
        schema:
          type: string
        examples:
          filterDestinationDataflows:
            summary: Filter dataflows for destinations only
            value: inheritedAttributes.properties.isDestinationFlow==true
          filterS3Dataflows:
            summary: Filter dataflows for Amazon S3 destination
            value: inheritedAttributes.targetConnections[].connectionSpec.id==4fce964d-3f37-408f-9778-e597338a21ee
          filterSftpDataflows:
            summary: Filter dataflows for SFTP destination
            value: inheritedAttributes.targetConnections[].connectionSpec.id==36965a81-b1c6-401b-99f8-22508f1e6a26
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/orderby'
      - $ref: '#/components/parameters/count'
      - $ref: '#/components/parameters/continuationToken'
      responses:
        '200':
          description: Successful operation. A successful response returns a list of dataflows that match the request parameters.
          x-summary: List of Dataflows Retrieved
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/Batch_Flow'
                - $ref: '#/components/schemas/Streaming_Flow'
              examples:
                Flows:
                  $ref: '#/components/examples/Batch_Flows'
        '401':
          description: The token provided in the Authorization header is invalid.
          x-summary: Invalid Authorization Token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error_code: 401013
                message: Oauth token is not valid
        '403':
          description: You are not authorized to perform this operation
          x-summary: Authorization Error - Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An Internal error occurred.
          x-summary: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - Dataflows
      summary: Create a destination dataflow
      description: 'You can create a destination dataflow by making a POST request to the `/flows` endpoint.

        '
      operationId: postFlow
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/Content-type'
      - $ref: '#/components/parameters/XApiKey'
      - $ref: '#/components/parameters/XImsOrgId'
      - $ref: '#/components/parameters/XSandboxId'
      - $ref: '#/components/parameters/Accept'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/Create_Batch_Destination_Flow_Request'
              - $ref: '#/components/schemas/Create_Streaming_Destination_Flow_Request'
              - $ref: '#/components/schemas/Create_Batch_Destination_Flow_Request_V2'
            examples:
              Create_Batch_Destination_Flow:
                $ref: '#/components/examples/Create_Batch_Destination_Flow'
              Create_Batch_Destination_Flow_Dataset_V2:
                $ref: '#/components/examples/Create_Batch_Destination_Flow_Dataset_V2'
              Create_Batch_Destination_Flow_Segment_V2:
                $ref: '#/components/examples/Create_Batch_Destination_Flow_Segment_V2'
      responses:
        '201':
          description: A new destination dataflow was successfully created. The response contains the unique identifier (ID) and the etag value of the dataflow.
          x-summary: Dataflow Created Successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Patch_Flow_Response'
              examples:
                Create_Flow_Response:
                  $ref: '#/components/examples/Create_Flow_Response'
        '401':
          description: The token provided in the Authorization header is invalid.
          x-summary: Invalid Authorization Token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error_code: 401013
                message: Oauth token is not valid
        '403':
          description: You are not authorized to perform this operation
          x-summary: Authorization Error - Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An Internal error occurred.
          x-summary: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /flows/{id}:
    get:
      tags:
      - Dataflows
      summary: Retrieve a destination dataflow's details
      description: 'You can retrieve detailed information about a specific destination dataflow by making a GET request to the `/flows` endpoint and providing the ID of the dataflow you want to inspect.

        '
      operationId: getFlowById
      parameters:
      - name: id
        in: path
        description: The ID of the destination dataflow you are looking to retrieve.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XApiKey'
      - $ref: '#/components/parameters/XImsOrgId'
      - $ref: '#/components/parameters/XSandboxId'
      - $ref: '#/components/parameters/Accept'
      responses:
        '200':
          description: The specified dataflow was successfully retrieved.
          x-summary: Dataflow Details Retrieved
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/Batch_Flow'
                - $ref: '#/components/schemas/Streaming_Flow'
              examples:
                Batch_Flow_Daily_Full_Once_Scheduled:
                  $ref: '#/components/examples/Batch_Flow_Daily_Full_Once_Scheduled'
                Batch_Flow_Daily_Full_Once_Chained:
                  $ref: '#/components/examples/Batch_Flow_Daily_Full_Once_Chained'
                Batch_Flow_Daily_Full_Scheduled:
                  $ref: '#/components/examples/Batch_Flow_Daily_Full_Scheduled'
                Batch_Flow_Daily_Full_Chained:
                  $ref: '#/components/examples/Batch_Flow_Daily_Full_Chained'
                Batch_Flow_First_Full_Then_Incremental_DAILY:
                  $ref: '#/components/examples/Batch_Flow_First_Full_Then_Incremental_DAILY'
                Batch_Flow_First_Full_Then_Incremental_EVERY_3_HOURS:
                  $ref: '#/components/examples/Batch_Flow_First_Full_Then_Incremental_EVERY_3_HOURS'
                Batch_Flow_Profile_Mapping_And_Identities_V2:
                  $ref: '#/components/examples/Batch_Flow_Profile_Mapping_And_Identities_V2'
                Batch_Flow_External_Audience_Profile_Mapping_And_Identities:
                  $ref: '#/components/examples/Batch_Flow_External_Audience_Profile_Mapping_And_Identities'
                Batch_Flow_Dataset_Schedule_V2:
                  $ref: '#/components/examples/Batch_Flow_Dataset_Schedule_V2'
        '401':
          description: The token provided in the Authorization header is invalid.
          x-summary: Invalid Authorization Token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error_code: 401013
                message: Oauth token is not valid
        '403':
          description: You are not authorized to perform this operation
          x-summary: Authorization Error - Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The specified dataflow ID was not found. The resource may have been deleted, or the requested path was entered incorrectly.
          x-summary: Not Found - Dataflow ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorMessage: flows not found with id = [ca5c6e9a-8559-4a08-97a5-f15b756da600-]
        '500':
          description: An Internal error occurred.
          x-summary: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      tags:
      - Dataflows
      summary: Update a destination dataflow
      description: 'You can update a destination dataflow by making a PATCH request to the `/flows` endpoint and providing the ID of the dataflow you want to update. In the body of the request, provide the updated configuration of the dataflow.

        '
      operationId: patchFlowById
      parameters:
      - name: id
        in: path
        description: The ID of the destination dataflow you are looking to update.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XApiKey'
      - $ref: '#/components/parameters/XImsOrgId'
      - $ref: '#/components/parameters/XSandboxId'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/Content-type'
      - $ref: '#/components/parameters/if-match'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Patch_Flow_Request'
            examples:
              Batch_Flow_Daily_Full_Once_Scheduled:
                $ref: '#/components/examples/Patch_Batch_Flow_Daily_Full_Once_Scheduled'
              Batch_Flow_External_Audience_Daily_Full_Once_Scheduled:
                $ref: '#/components/examples/Patch_Batch_Flow_External_Audience_Daily_Full_Once_Scheduled'
              Batch_Flow_Enrichment_Info_Daily_Full_Once_Scheduled:
                $ref: '#/components/examples/Patch_Batch_Flow_Enrichment_Info_Daily_Full_Once_Scheduled'
              Batch_Flow_Daily_Full_Once_Chained:
                $ref: '#/components/examples/Patch_Batch_Flow_Daily_Full_Once_Chained'
              Add_Profile_Selectors:
                $ref: '#/components/examples/Patch_Profile_Selectors'
              Update_Source_Connection:
                $ref: '#/components/examples/Patch_Source_Connection'
              Update_Dataset_Schedule:
                $ref: '#/components/examples/Patch_Dataset_Schedule_Params'
              Patch_Profile_Mapping:
                $ref: '#/components/examples/Patch_Profile_Mapping'
              Patch_Primary_Fields:
                $ref: '#/components/examples/Patch_Primary_Fields'
              Patch_Mandatory_Fields:
                $ref: '#/components/examples/Patch_Mandatory_Fields'
      responses:
        '200':
          description: Details of your newly updated dataflow are returned.
          x-summary: Dataflow Updated Successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Patch_Flow_Response'
              examples:
                Patch_Flow_Response:
                  $ref: '#/components/examples/Patch_Flow_Response'
        '401':
          description: The token provided in the Authorization header is invalid.
          x-summary: Invalid Authorization Token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error_code: 401013
                message: Oauth token is not valid
        '403':
          description: You are not authorized to perform this operation
          x-summary: Authorization Error - Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The specified dataflow ID was not found. The resource may have been deleted, or the requested path was entered incorrectly.
          x-summary: Not Found - Dataflow ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorMessage: flows not found with id = [ca5c6e9a-8559-4a08-97a5-f15b756da600-]
                errorDetails: flows not found with id = [ca5c6e9a-8559-4a08-97a5-f15b756da600-]
        '412':
          description: Pre-condition failed error. This can occur if the supplied eTag does not match the latest eTag for the resource. <br> To resolve this, you need to fetch the entity again, make sure that your changes are compatible with new version of the entity, then place the new etag in the If-Match header, and finally make the API call.
          x-summary: Precondition Failed - ETag Mismatch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorMessage: Supplied version=["04001277-0000-0200-0000-62d9b13e00001"] does not match the current version on entity=["0400117f-0000-0200-0000-62d9bca50000"]
                errorDetails: Supplied version=["04001277-0000-0200-0000-62d9b13e00001"] does not match the current version on entity=["0400117f-0000-0200-0000-62d9bca50000"]
        '500':
          description: An Internal error occurred.
          x-summary: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
      - Dataflows
      summary: Delete a destination dataflow
      description: 'You can delete the specified destination dataflow by making a DELETE request to the `/flows` endpoint and providing the ID of the dataflow that you wish to delete in the request path.

        '
      operationId: deleteFlowById
      parameters:
      - name: id
        in: path
        description: The ID of the destination dataflow you are looking to delete.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XApiKey'
      - $ref: '#/components/parameters/XImsOrgId'
      - $ref: '#/components/parameters/XSandboxId'
      - $ref: '#/components/parameters/Accept'
      responses:
        '202':
          description: A successful response returns HTTP status 202 (No Content) and a blank body. You can confirm the deletion by attempting a lookup (GET) request to the dataflow. The API will return an HTTP 404 (Not Found) error, indicating that the dataflow has been deleted.
          x-summary: Deletion Accepted - Dataflow Marked for Deletion
        '401':
          description: The token provided in the Authorization header is invalid.
          x-summary: Invalid Authorization Token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error_code: 401013
                message: Oauth token is not valid
        '403':
          description: You are not authorized to perform this operation
          x-summary: Authorization Error - Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The specified dataflow ID was not found. The resource may have been deleted, or the requested path was entered incorrectly.
          x-summary: Not Found - Dataflow ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorMessage: flows not found with id = [ca5c6e9a-8559-4a08-97a5-f15b756da600-]
        '500':
          description: An Internal error occurred.
          x-summary: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    BaseSegmentSelectorValue:
      type: object
      title: Segment Selector Value Object
      description: "Contains the fields that are relevant for the segment activation, including information about the export schedule, export mode, and more. \n"
      properties:
        id:
          type: string
          title: Segment ID
          description: Specify the ID of the segment you are adding to the destination dataflow.
        systemSegmentId:
          type: string
          title: System Segment ID
          description: An identifier used for externally generated audiences brought into Experience Platform.
        namespace:
          type: string
          title: Namespace
          description: Indicates the origin of the audience. An external origin describes external audiences brought into Experience Platform, while an internal origin describes audiences created in Experience Platform through the Segmentation Service.
        name:
          type: string
          title: Segment name
          description: Specify the name of the segment you are adding to the destination dataflow. Note that this field is not mandatory and you can successfully add a segment to the destination dataflow without providing its name.
        description:
          type: string
          title: Description
          description: Specify the description of the segment you are adding to the destination dataflow. Note that this field is not mandatory and you can successfully add a segment to the destination dataflow without providing its description.
        exportMode:
          type: string
          title: Export Mode
          description: "For more information about the two options, refer to [export full files](https://experienceleague.adobe.com/docs/experience-platform/destinations/ui/activate/activate-batch-profile-destinations.html#export-full-files) and [export incremental files](https://experienceleague.adobe.com/docs/experience-platform/destinations/ui/activate/activate-batch-profile-destinations.html#export-incremental-files) in the batch destinations activation tutorial. \n"
          enum:
          - DAILY_FULL_EXPORT
          - FIRST_FULL_THEN_INCREMENTAL
        createTime:
          type: string
          title: Create Time
          description: A system-generated time in epoch seconds to represent when the segment was first activated to the flow.
          example: '1658344069'
        updateTime:
          type: string
          title: Update Time
          description: A system-generated time in epoch seconds to represent when the segment activation details were modified.
          example: '1658427026'
        schedule:
          type: object
          description: Indicates various settings related to the export schedule of a segment to your destination.
          properties:
            frequency:
              type: string
              title: Export Frequency
              description: Indicates the frequency with which files are exported from Experience Platform to your destination. The options `EVERY_3_HOURS`, `EVERY_6_HOURS`, `EVERY_8_HOURS`, `EVERY_12_HOURS` are supported for incremental file exports only.
              enum:
              - ONCE
              - DAILY
              - EVERY_3_HOURS
              - EVERY_6_HOURS
              - EVERY_8_HOURS
              - EVERY_12_HOURS
            triggerType:
              type: string
              title: Trigger Type
              description: 'This field is required only when selecting the `DAILY_FULL_EXPORT` mode in the frequency selector. Supported frequency types are `ONCE` and `DAILY`. <br> 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. <br> 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 a `startTime` to indicate at which time in UTC the daily exports should occur.

                '
              enum:
              - SCHEDULED
              - AFTER_SEGMENT_EVAL
            startDate:
              type: string
              title: Start Date
              description: The date when the segment should start exporting profiles to your destination. <br> The correct format is `YYYY-MM-DD`.
              example: '2022-07-20'
            endDate:
              type: string
              title: End Date
              description: 'Not applicable when selecting `"exportMode":"DAILY_FULL_EXPORT"` and `"frequency":"ONCE"`. Sets the date when segment members stop being exported to the destination. <br> The correct format is `YYYY-MM-DD`.

                '
              example: '2022-07-29'
            startTime:
              type: string
              title: Start Time
              description: 'A 24-hour format to represent when files containing members of the segment should be generated  and exported to your destination.  Note: This field is not applicable when you define `"exportMode":"DAILY_FULL_EXPORT"` and  `"triggerType"="AFTER_SEGMENT_EVAL"`. <br> The correct format is `HH:MM`. Minutes must be `00`.

                '
              example: '20:00'
    FlowSpec_V2:
      type: object
      title: (Beta) Flow Spec
      description: Model to capture the flow specification. Each destination has a specific flow spec ID in Experience Platform.
      properties:
        id:
          type: string
          title: Flow Spec ID.
          enum:
          - 1a0514a6-33d4-4c7f-aff8-594799c47549
          - 269ba276-16fc-47db-92b0-c1049a3c131f
          - fd36aaa4-bf2b-43fb-9387-43785eeeb799
          - 354d6aad-4754-46e4-a576-1b384561c440
          - 752d422f-b16f-4f0d-b1c6-26e448e3b388
          - 95bd8965-fc8a-4119-b9c3-944c2c2df6d2
          - 976d663b-80b4-4193-be6b-2d0487516623
          - 585c15c4-6cbf-4126-8f87-e26bff78b657
          - 7e635b9f-e59b-4546-8ba8-fce6496693c8
          - cd2fc47e-e838-4f38-a581-8fff2f99b63a
          - db060570-a155-418a-a6d3-b4d97698e5dc
          - 17be2013-2549-41ce-96e7-a70363bec293
          description: "The Flow Spec ID of the destination that you are looking to connect and activate segments or datasets to. To retrieve the flow spec ID, perform a `GET` operation on the `flowspecs` endpoint, as shown in the [flow specs API reference documentation](https://developer.adobe.com/experience-platform-apis/references/flow-service/#operation/retrieveFlowSpec). Please note that these beta destinations support both dataset and profile exports so use the appropriate Flow Spec ID.<br><br>\nFlow Spec ID:\n  * `1a0514a6-33d4-4c7f-aff8-594799c47549`: (Beta) Amazon S3 - Segment\n  * `269ba276-16fc-47db-92b0-c1049a3c131f`: (Beta) Amazon S3 - Dataset\n  * `fd36aaa4-bf2b-43fb-9387-43785eeeb799`: (Beta) SFTP - Segment\n  * `354d6aad-4754-46e4-a576-1b384561c440`: (Beta) SFTP - Dataset\n  * `752d422f-b16f-4f0d-b1c6-26e448e3b388`: (Beta) Azure Blob Storage - Segment\n  * `95bd8965-fc8a-4119-b9c3-944c2c2df6d2`: (Beta) Azure Blob Storage - Dataset\n  * `976d663b-80b4-4193-be6b-2d0487516623`: (Beta) Google Cloud Storage - Segment\n  * `585c15c4-6cbf-4126-8f87-e26bff78b657`: (Beta) Google Cloud Storage - Dataset\n  * `7e635b9f-e59b-4546-8ba8-fce6496693c8`: (Beta) Data Landing Zone - Segment\n  * `cd2fc47e-e838-4f38-a581-8fff2f99b63a`: (Beta) Data Landing Zone - Dataset\n  * `db060570-a155-418a-a6d3-b4d97698e5dc`: (Beta) Azure Data Lake Gen2 - Segment\n  * `17be2013-2549-41ce-96e7-a70363bec293`: (Beta) Azure Data Lake Gen2 - Dataset\n"
    Patch_Flow_Response:
      type: object
      title: Patch Flow Response
      description: API response for a successful PATCH operation.
      properties:
        id:
          type: string
          title: Flow ID
          description: The dataflow ID for which the API request was made.
        etag:
          type: string
          title: E-Tag
          description: An updated etag for the dataflow ID.
    DatasetScheduleParams_V2:
      type: object
      title: Dataset Schedule Params
      description: Schedule params for controlling dataset exports schedule.
      required:
      - startTime
      - interval
      - timeUnit
      properties:
        exportMode:
          title: Export mode
          type: string
          description: Select `DAILY_FULL_EXPORT` or `FIRST_FULL_THEN_INCREMENTAL`. <br> `DAILY_FULL_EXPORT` can only be used in combination with `timeUnit`:`day` and `interval`:`0` for a one-time full export of the dataset. Daily full exports of datasets are not supported. If you need daily exports, use the incremental export option. <br> `FIRST_FULL_THEN_INCREMENTAL` triggers an export of one or multiple files representing a full snapshot of the dataset. Subsequent files are incremental additions to the dataset since the previous export.
          enum:
          - DAILY_FULL_EXPORT
          - FIRST_FULL_THEN_INCREMENTAL
        startTime:
          title: Start Time
          type: integer
          description: The start time of the dataset export expressed as a timestamp in epoch **seconds**.
        endTime:
          title: End Time
          type: integ

# --- truncated at 32 KB (166 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/openapi/adobe-suite-dataflows-api-openapi.yml