Delete a destination configuration

This page exemplifies the API request and payload that you can use to delete an existing destination configuration, using the /authoring/destinations API endpoint.

All parameter names and values supported by Destination SDK are case sensitive. To avoid case sensitivity errors, please use the parameters names and values exactly as shown in the documentation.

Getting started with destination configuration API operations get-started

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.

Delete a destination configuration delete

You can delete an existing destination server configuration by making a DELETE request to the /authoring/destinations endpoint with the {INSTANCE_ID}of the destination configuration that you want to delete.

API endpoint:

To obtain an existing destination configuration and its corresponding {INSTANCE_ID}, see the article about retrieving a destination configuration.

API format

DELETE /authoring/destinations/{INSTANCE_ID}
The ID of the destination configuration you want to delete.
code language-shell
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \

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

API error handling 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 delete an existing destination configuration through the Destination SDK /authoring/destinations API endpoint.

To learn more about what you can do with this endpoint, see the following articles: