Update a destination server configuration
This page exemplifies the API request and payload that you can use to update an existing destination server configuration, using the /authoring/destination-servers
API endpoint.
For a detailed description of the capabilities that you can configure through this endpoint, read the following articles:
Getting started with destination server 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.
Update a destination server configuration update
You can update an existing destination server configuration by making a PUT
request to the /authoring/destination-servers
endpoint with the updated payload.
platform.adobe.io/data/core/activation/authoring/destination-servers
To obtain an existing destination server configuration and its corresponding {INSTANCE_ID}
, see the article about retrieving a destination server configuration.
API format
PUT /authoring/destination-servers/{INSTANCE_ID}
{INSTANCE_ID}
{INSTANCE_ID}
, see Retrieve a destination server configuration.The following requests update an existing destination server configuration, configured by the parameters provided in the payload.
Select each tab below to view the corresponding payload.
accordion | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request | ||||||||||||||||||||||||||||||||
|
accordion |
---|
Response |
A successful response returns HTTP status 200 with the details of your updated destination server configuration. |
accordion | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request | |||||||||||||||||||||||||||||
|
accordion |
---|
Response |
A successful response returns HTTP status 200 with the details of your updated destination server configuration. |
accordion | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request | |||||||||||||||||||||||||||||||||||
|
accordion |
---|
Response |
A successful response returns HTTP status 200 with the details of your updated destination server configuration. |
accordion | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request | |||||||||||||||||||||||
|
accordion |
---|
Response |
A successful response returns HTTP status 200 with the details of your updated destination server configuration. |
accordion | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request | |||||||||||||||||||||||||||||
|
accordion |
---|
Response |
A successful response returns HTTP status 200 with the details of your updated destination server configuration. |
accordion | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request | |||||||||||||||||||||||
|
accordion |
---|
Response |
A successful response returns HTTP status 200 with the details of your updated destination server configuration. |
accordion | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request | |||||||||||||||||||||||||||||
|
accordion |
---|
Response |
A successful response returns HTTP status 200 with the details of your updated destination server configuration. |
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 next-steps
After reading this document, you now know how to update a destination server configuration through the Destination SDK /authoring/destination-servers
API endpoint.
To learn more about what you can do with this endpoint, see the following articles: