---
title: "EntityFitnessIndicators.update"
method: PATCH
path: "/entities/EntityFitnessIndicators/{id}"
tags: ["Opportunity"]
---

# EntityFitnessIndicators.update

`PATCH /entities/EntityFitnessIndicators/{id}`

Modifies EntityFitnessIndicator or EntityFitnessIndicators with given id(s)

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateEntityFitnessIndicatorInput
  - `description` string — Description of what the indicator measures, shown in the UI.
  - `description_use_lang` boolean — When true, description is treated as a translation key and localized in the UI.
  - `entity_fitness_id` string, uuid — Id of the fitness configuration.
  - `how_to_fix` string — Suggested remediation text shown to the user when a record triggers this indicator.
  - `how_to_fix_use_lang` boolean — When true, how_to_fix is treated as a translation key and localized in the UI.
  - `is_enabled` boolean — When false, the indicator is configured but not evaluated for records.
  - `name` string — Display name of the indicator.
  - `name_use_lang` boolean — When true, name is treated as a translation key and localized in the UI; otherwise the literal text is shown.
  - `settings` string, binary — Indicator rules. For system indicators contains three thresholds (Notice, Warning, Error); for custom indicators contains user-defined filter rules.
  - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Custom, 2 - LowEmailOutreach, 3 - LowEmailEngagement, 4 - TasksOverdue, 5 - NoFollowUp, 6 - ClosingDateOverdue, 7 - SalesStepVelocityOverdue, 8 - SalesCycleOverdue, 9 - ManyClosingDateUpdates, 10 - MovedToPreviousStep, 11 - RankingDecrease, 12 - ValueDecrease
  - `revision` integer — Revision when entity was lastly changed.

## Response `200`

Modification confirmation. Returns resulting EntityFitnessIndicator

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` EntityFitnessIndicator
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, uuid, required — Unique identifier of entity.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `entity_fitness` string, uri, required — Fitness configuration this indicator belongs to. Relation to EntityFitness. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EntityFitness' object for properties.
    - `description` string, required — Description of what the indicator measures, shown in the UI.
    - `description_use_lang` boolean, required — When true, description is treated as a translation key and localized in the UI.
    - `entity_fitness_id` string, uuid, required — Id of the fitness configuration.
    - `how_to_fix` string, required — Suggested remediation text shown to the user when a record triggers this indicator.
    - `how_to_fix_use_lang` boolean, required — When true, how_to_fix is treated as a translation key and localized in the UI.
    - `is_enabled` boolean, required — When false, the indicator is configured but not evaluated for records.
    - `name` string, required — Display name of the indicator.
    - `name_use_lang` boolean, required — When true, name is treated as a translation key and localized in the UI; otherwise the literal text is shown.
    - `settings` string, binary, required — Indicator rules. For system indicators contains three thresholds (Notice, Warning, Error); for custom indicators contains user-defined filter rules.
    - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12, required — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Custom, 2 - LowEmailOutreach, 3 - LowEmailEngagement, 4 - TasksOverdue, 5 - NoFollowUp, 6 - ClosingDateOverdue, 7 - SalesStepVelocityOverdue, 8 - SalesCycleOverdue, 9 - ManyClosingDateUpdates, 10 - MovedToPreviousStep, 11 - RankingDecrease, 12 - ValueDecrease
    - `revision` integer — Revision when entity was lastly changed.

## Other responses

- `404` — Sent when invalid ID is given
- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/versions/e8c12ae60aca/schema)