Update Configuration

The Update Configuration endpoint enables you to update an existing configuration based on the provided configId and request payload.

📘

Note

Partial updates, where mandatory fields are not included in the request, are not supported. Omitting any mandatory fields results in a 400 Bad Request response.

You can update a configuration by making a PUT request to the Update Configuration endpoint, including the configId you want to update in the URL. For example:

{{base-url}}/eds/api/v1/Configs/{configId}

You can find an example of an Update Configuration request body below. To update an existing configuration, provide the configId along with both status and messageTypeFilter in the request body. The system replaces the existing values with the new ones provided.

In the following example, the status of the configuration is updated to active, and the message types of 1 and 3 are added to the configuration, replacing previous transaction/message types against the configuration.

{
    "status": "active",
    "messageTypeFilter": [1,3]
}

If successful, a 200 response is returned.

👍

More Information

• For more information on the fields in the Update Configuration endpoint, see Update Configuration - Field Descriptions.
• To view the endpoint in the API Explorer, see Update Configuration.