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

# ActivityKPIs.update

`PATCH /entities/ActivityKPIs/{id}`

## 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/ActivityKPIs/{id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/ActivityKPIs/:id/patch.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateActivityKPIInput: Field values to change on an ActivityKPI record; fields left out keep their values.
  - `activity_id` string, uuid: Id of the appointment or task the KPI event relates to.
  - `application_id` string, uuid: Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration).
  - `client_id` string, uuid: Id of the user who triggered the event.
  - `kpi` 1 | 2 | 3: KPI metric this event represents: ActivityCreate, ActivityCompleted or LastModified. Integer enum value: 1 - ActivityCreate, 2 - ActivityCompleted, 3 - LastModified
  - `owner_id` string, uuid: Id of the activity owner at the time of the event.
  - `unit_id` string, uuid: Id of the sales unit.
  - `revision` integer: Revision when entity was lastly changed.

## Response `200`

The changed ActivityKPI record.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` ActivityKPI: Recorded KPI event of a task or an appointment, such as its creation or completion, used in KPI reports.
    - `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.
    - `appointment` string, uri: Appointment this KPI event relates to. Set when activity_id resolves to an Appointment; otherwise empty. Related Appointment record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Appointment' for its fields.
    - `task` string, uri: Task this KPI event relates to. Set when activity_id resolves to a Task; otherwise empty. Related Task record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Task' for its fields.
    - `client` string, uri: User who triggered the KPI event (e.g. created or completed the activity). Related Client record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Client' for its fields.
    - `owner` string, uri: Activity owner at the time the KPI event occurred. Related Client record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Client' for its fields.
    - `unit` string, uri, required: Sales unit the triggering user belonged to at the time of the event. Related SalesUnit record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'SalesUnit' for its fields.
    - `activity_id` string, uuid, required: Id of the appointment or task the KPI event relates to.
    - `application_id` string, uuid: Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration).
    - `client_id` string, uuid: Id of the user who triggered the event.
    - `kpi` 1 | 2 | 3, required: KPI metric this event represents: ActivityCreate, ActivityCompleted or LastModified. Integer enum value: 1 - ActivityCreate, 2 - ActivityCompleted, 3 - LastModified
    - `owner_id` string, uuid: Id of the activity owner at the time of the event.
    - `unit_id` string, uuid, required: Id of the sales unit.
    - `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).
- `404`: No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE).
- `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)