Skip to main content
POST
Update a market-data provider.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

Current environment Name, NewName, NewDescription, and IsActive; the entity type is fixed to market-data provider and IsActive=false deactivates it. The current contract accepts empty new-name and new-description values.

Current market-data-environment selection and replacement display details and active state.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketDataProvider.ApiMarketDataProviderUpdateRequest, Derivitec.Web.Core
new_name
string | null

Replacement client-visible name for the selected configurable entity.

new_description
string | null

Replacement client-visible description for the selected configurable entity.

is_active
boolean

Replacement lifecycle state: true keeps the entity available and false deactivates it.

name
string | null

Name of the entity to select within the request's entity category. The value must not be null or empty.

Example:

"Example entity"

Response

Returns the update result, including missing/current-name, access, missing-ID, or duplicate-new-name errors.

Outcome of updating a market-data environment.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketDataProvider.ApiMarketDataProviderUpdateResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.