--- title: "EntityFitnessIndicators.create" method: POST path: "/entities/EntityFitnessIndicators" tags: ["Opportunity"] --- # EntityFitnessIndicators.create `POST /entities/EntityFitnessIndicators` ## Request - Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id` - URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/EntityFitnessIndicators` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Creates a EntityFitnessIndicator record. ## Query parameters - `validation-level` integer ## Request body - CreateEntityFitnessIndicatorInput: Field values of a new EntityFitnessIndicator record. - `modified` string, date-time: Last modification time. - `created` string, date-time: Creation time. - `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. This payload conforms to the `FitnessIndicatorSettings` JSON Schema (see the linked schema). - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12, required: 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 - `revision` integer: Revision when entity was lastly changed. ## Response `201` The created EntityFitnessIndicator record. - object - `success` boolean: True when the request succeeded; false on error. - `data` EntityFitnessIndicator: Indicator of a fitness configuration: a rule that flags lead or opportunity records needing attention and suggests how to fix them. - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. - `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. Related EntityFitness record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'EntityFitness' for its fields. - `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. This payload conforms to the `FitnessIndicatorSettings` JSON Schema (see the linked schema). - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12, required: 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 - `revision` integer: Revision when entity was lastly changed. ## Other responses - `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`. - `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED). - `422`: Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written. - `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry. - `500`: Unexpected server error (code 1000, ERROR_UNKNOWN). --- [API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)