v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Opportunity

EntityFitnessIndicators.update

Modifies EntityFitnessIndicator or EntityFitnessIndicators with given id(s)

patch/entities/EntityFitnessIndicators/{id}

Path parameters

idstring uuid required

ID of EntityFitnessIndicator to update

Query parameters

validation-levelinteger

Specify validation level of EntityFitnessIndicator on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

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.

type1 | 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

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

Modification confirmation. Returns resulting EntityFitnessIndicator

successboolean

True when response 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
  }
}