COcoevera
Account

AccountKPIs.update

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

patch/entities/AccountKPIs/{id}

Request

Path parameters

idstring uuid required

Id of the AccountKPI 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

account_idstring uuid

Id of the account this KPI event relates to.

application_idstring uuid

Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration).

client_idstring uuid

Id of the user who triggered the event.

kpi1 | 2 | 3 | 4 | 5

KPI metric this event represents: CreateAccount, FirstEmailSent, LastEmailSent, Archive or LastModified.

Integer enum value: 1 - CreateAccount, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive, 5 - LastModified

owner_idstring uuid

Id of the account owner at the time of the event.

unit_idstring uuid

Id of the sales unit.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "account_id": "01234567-abcd-dcba-ffff-000000000000",
  "application_id": "01234567-abcd-dcba-ffff-000000000000",
  "client_id": "01234567-abcd-dcba-ffff-000000000000",
  "kpi": 1,
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "unit_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1
}

Response

The changed AccountKPI 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",
    "account_id": "01234567-abcd-dcba-ffff-000000000000",
    "application_id": "01234567-abcd-dcba-ffff-000000000000",
    "client_id": "01234567-abcd-dcba-ffff-000000000000",
    "kpi": 1,
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1
  }
}

Changes

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