---
title: "Updates the definition of a composite indicator"
method: PUT
path: "/indicator/composite/definition/{Provider}/{ProviderId}"
tags: ["Indicator"]
---

# Updates the definition of a composite indicator

`PUT /indicator/composite/definition/{Provider}/{ProviderId}`

updates the definition for a given composite indicator in the system

## Path parameters

- `Provider` string, required
- `ProviderId` string, required

## Request body

- CompositeDefinitionUpdateRequest — Request used to update the formula of an existing composite indicator, the mix of indicators used as variables in the composite formula, or metadata about the composite indicator.
  - `entries` CompositeEntryUpdateRequest[], nullable — Indicator Entries that are used in the composite formula
    - `provider` string, nullable — Unique Identifier for Provider.
    - `providerId` string, nullable — Identifier for indicator
    - `offset` integer — Offset applied to indicator
    - `calculation` string, nullable — Calculation of indicator
  - `formula` string, nullable — Formula for composite Indicator where each variable represents a CompositeIndicatorEntry
  - `startDate` string, date-time, nullable — Optional Start Date of Composite, when blank the series will start on the first common date across variables
  - `compositeMetadata` BaseIndicatorMetadataWithFrequencyRequest
    - `provider` string, nullable — Unique identifier for provider
    - `providerId` string, nullable — Indicator Identifier
    - `name` string, nullable — Indicator Name
    - `description` string, nullable — Indicator Description
    - `notes` string, nullable — Indicator Notes
    - `units` string, nullable — Indicator Units of measurement
    - `citation` string, nullable — Indicator Citation
    - `path` string, nullable — Path of indicator in Prevedere folder structure
    - `color` string, nullable — Color code to be used in the Prevedere application
    - `aggregation` string, nullable — Aggregation method used for indicator time series
    - `tags` string[], nullable — Tags assigned to help organize indicator
    - `industryCodes` IndustryCode[], nullable — Industry codes assigned to indicator
      - `type` string, nullable
      - `code` string, nullable
    - `classification` string, nullable — Prevedere Classification for indicator
    - `seasonalAdjustment` string, nullable — Identifies if indicator is seasonally adjusted
    - `periodAlignment` string, nullable — Identifies if time series aligns with the beginning or end of time period
    - `interval` string, nullable — Name and multiple used to describe period length of indicator the time series, similar to frequency
    - `frequency` string, nullable — Frequency of indicator time series

## Response `200`

OK

- CompositeDefinitionUpdateResponse
  - `compositeDefinition` CompositeDefinition — This schema contains the definition of a composite indicator. It includes the formula, start date and information for each indicator used in the formula.
    - `entries` CompositeIndicatorEntry[], nullable — A list of indicators used in the composite formula.
      - `provider` string, nullable — Unique Identifier for Provider.
      - `providerId` string, nullable — Identifier for indicator
      - `offset` integer — Offset applied to indicator
      - `calculation` string, nullable — Calculation of indicator
      - `variableName` string, nullable — Variable name for indicator that is reference in the formula
    - `formula` string, nullable — Formula for composite Indicator
    - `startDate` string, date-time, nullable — Start Date of Composite Indicator
    - `compositeMetadata` CompositeMetadata — This schema contains the metadata for the composite indicator
      - `provider` string, nullable — Unique identifier for provider
      - `providerId` string, nullable — Indicator Identifier
      - `name` string, nullable — Indicator Name
      - `description` string, nullable — Indicator Description
      - `notes` string, nullable — Indicator Notes
      - `units` string, nullable — Indicator Units of measurement
      - `citation` string, nullable — Indicator Citation
      - `path` string, nullable — Path of indicator in Prevedere folder structure
      - `color` string, nullable — Color code to be used in the Prevedere application
      - `aggregation` string, nullable — Aggregation method used for indicator time series
      - `tags` string[], nullable — Tags assigned to help organize indicator
      - `industryCodes` IndustryCode[], nullable — Industry codes assigned to indicator
        - `type` string, nullable
        - `code` string, nullable
      - `classification` string, nullable — Classification for indicator
      - `seasonalAdjustment` string, nullable — Identifies if indicator is seasonally adjusted
      - `periodAlignment` string, nullable — Identifies if time series aligns with the beginning or end of time period
      - `interval` string, nullable — Name and multiple used to describe period length of indicator time series, similar to frequency
      - `frequency` string, nullable — Frequency of indicator time series
      - `calculation` string, nullable — Calculation of composite indicator
  - `messages` ResponseMessage[], nullable
    - `code` string, nullable
    - `message` string, nullable

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `429` — If the user has sent too many requests

---

[API](https://skmtc.net/prevedere/apis/board-foresight-api-v1.md) · [All operations](https://skmtc.net/prevedere/apis/board-foresight-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/prevedere/board-foresight-api-v1/revisions/c5ac8232e334/schema)