COcoevera
Opportunity

EntityFitnessIndicators.update

Changes fields of the EntityFitnessIndicator record with the given id; fields left out keep their values.

patch/entities/EntityFitnessIndicators/{id}

Request

Path parameters

idstring uuid required

Id of the EntityFitnessIndicator record to update.

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

descriptionstring

Description of what the indicator measures, shown in the UI.

description_use_langboolean

When true, description is treated as a translation key and localized in the UI.

entity_fitness_idstring uuid

Id of the fitness configuration.

how_to_fixstring

Suggested remediation text shown to the user when a record triggers this indicator.

how_to_fix_use_langboolean

When true, how_to_fix is treated as a translation key and localized in the UI.

is_enabledboolean

When false, the indicator is configured but not evaluated for records.

namestring

Display name of the indicator.

name_use_langboolean

When true, name is treated as a translation key and localized in the UI; otherwise the literal text is shown.

settingsstring binary

Indicator rules. For system indicators contains three thresholds (Notice, Warning, Error); for custom indicators contains user-defined filter rules. This payload conforms to the FitnessIndicatorSettings JSON Schema (see the linked schema).

type1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12

Rule the indicator evaluates. Custom indicators use user-defined filter rules and can be deleted; all other values are built-in system indicators with three threshold rules in settings that cannot be deleted.

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

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "description": "string",
  "entity_fitness_id": "01234567-abcd-dcba-ffff-000000000000",
  "how_to_fix": "string",
  "name": "string",
  "settings": "blob",
  "type": 1,
  "revision": 1
}

Response

The changed EntityFitnessIndicator record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "description": "string",
    "entity_fitness_id": "01234567-abcd-dcba-ffff-000000000000",
    "how_to_fix": "string",
    "name": "string",
    "settings": "blob",
    "type": 1,
    "revision": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.