Delete a destination account using the Flow Service API

Destinations are pre-built integrations with destination platforms that allow for the seamless activation of data from Adobe Experience Platform. You can use destinations to activate your known and unknown data for cross-channel marketing campaigns, email campaigns, targeted advertising, and many other use cases.

Before activating data, you need to connect to the destination by first setting up a destination account. This tutorial covers the steps to delete destination accounts that are not needed anymore by using the Flow Service API.

Getting started get-started

This tutorial requires you to have a valid connection ID. The connection ID represents the account connection to the destination. If you do not have a valid connection ID, select your destination of choice from the destinations catalog and follow the steps outlined to connect to the destination before attempting this tutorial.

This tutorial also requires you to have a working understanding of the following components of Adobe Experience Platform:

The following sections provide additional information that you will need to know in order to successfully delete a destination account using the Flow Service API.

Reading sample API calls reading-sample-api-calls

This tutorial provides example API calls to demonstrate how to format your requests. These include paths, required headers, and properly formatted request payloads. Sample JSON returned in API responses is also provided. For information on the conventions used in documentation for sample API calls, see the section on how to read example API calls in the Experience Platform troubleshooting guide.

Gather values for required headers gather-values-for-required-headers

In order to make calls to Platform APIs, you must first complete the authentication tutorial. Completing the authentication tutorial provides the values for each of the required headers in all Experience Platform API calls, as shown below:

All resources in Experience Platform, including those belonging to Flow Service, are isolated to specific virtual sandboxes. All requests to Platform APIs require a header that specifies the name of the sandbox the operation will take place in:

All requests that contain a payload (POST, PUT, PATCH) require an additional media type header:

Find the connection ID of the destination account that you want to delete find-connection-id

The first step in deleting a destination account is to find out the connection ID that corresponds to the destination account that you want to delete.

In the Experience Platform UI, browse to Destinations > Accounts and select the account that you want to delete by selecting the number in the Destinations column.

Next, you can retrieve the connection ID of the destination account from the URL in your browser.

Delete connection delete-connection

Once you have a connection ID and have ensured that no dataflows exist to the destination account, perform a DELETE request to the Flow Service API.

API format

DELETE /connections/{CONNECTION_ID}

Request

curl -X DELETE \
    'https://platform.adobe.io/data/foundation/flowservice/connections/c8622ec7-7d94-44a5-a35a-ffcc6bdcc384' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

Response

A successful response returns HTTP status 204 (No Content) and a blank body. You can confirm the deletion by attempting a lookup (GET) request to the connection. The API will return an HTTP 404 (Not Found) error, indicating that the destination account has been deleted.

API error handling api-error-handling

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

Next steps

By following this tutorial, you have successfully used the Flow Service API to delete existing destination accounts. For more information on using destinations, refer to the destinations overview.