v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Activity

ActivityKPIs.update

Modifies ActivityKPI or ActivityKPIs with given id(s)

patch/entities/ActivityKPIs/{id}

Path parameters

idstring uuid required

ID of ActivityKPI to update

Query parameters

validation-levelinteger

Specify validation level of ActivityKPI 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

activity_idstring uuid

Id of the appointment or task the 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

KPI metric this event represents: ActivityCreate, ActivityCompleted.

Integer enum value: 1 - ActivityCreate, 2 - ActivityCompleted

owner_idstring uuid

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

unit_idstring uuid

Id of the sales unit.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "activity_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

Modification confirmation. Returns resulting ActivityKPI

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",
    "activity_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
  }
}