Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Target

Targets.update

Modifies Target or Targets with given id(s)

patch/entities/Targets/{id}

Path parameters

idstring uuid required

ID of Target to update

Query parameters

validation-levelinteger

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

calculation_type1 | 2 | 3

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 1 - Revenue, 2 - LeadQualified, 3 - LeadCreated

currency_idstring uuid

Id of the target currency.

descriptionstring

Free-text description shown alongside the target.

is_activeboolean

When true, the target is currently being tracked; when false, the target is a draft or has been deactivated.

namestring

Name of the entity and its default text representation.

owner_idstring uuid

Id of the owning user.

period_fromstring date

First date of the active target period. Set when is_active is true; recomputed from settings.period when activated.

period_tostring date

Last date of the active target period.

target_client_idstring uuid

Id of the assignee user.

type1 | 2 | 3 | 4

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 1 - User, 2 - GroupFromUser, 3 - GroupFromExisting, 4 - Simulated

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "calculation_type": 1,
  "currency_id": "01234567-abcd-dcba-ffff-000000000000",
  "description": "string",
  "name": "string",
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "period_from": "2019-01-01",
  "period_to": "2019-01-01",
  "target_client_id": "01234567-abcd-dcba-ffff-000000000000",
  "type": 1,
  "revision": 1
}

Response

Modification confirmation. Returns resulting Target

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",
    "calculation_type": 1,
    "currency_id": "01234567-abcd-dcba-ffff-000000000000",
    "description": "string",
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "period_from": "2019-01-01",
    "period_to": "2019-01-01",
    "settings": "blob",
    "target_client_id": "01234567-abcd-dcba-ffff-000000000000",
    "type": 1,
    "revision": 1
  }
}