Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
goalTarget

Update an existing goal target

patch/v1/org/{orgId}/goal/{goalId}/target/{goalTargetId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

goalIdstring required

Goal id

goalTargetIdstring required

Goal target id

Request body

goalIdstring

goal id that this target belongs to

labelstring

human-readable name of the goal target

slugstring

url-safe slug for the goal target, auto-generated from goal slug and label if not provided

direction'MINIMIZE' | 'MAXIMIZE' | 'TARGET'

direction of the target -- whether we want to minimize or maximize the value

type'MILESTONE' | 'MONEY' | 'PERCENT' | 'INTEGER' | 'DECIMAL'

type of the target value

valueExprstring

Carrot expression used to compute the current value versus target -- if not provided, GoalProgress will be used to track progress

startDatestring date

start date for this goal target

endDatestring date

end date for this goal target

Example request

{
  "goalId": "588f7ee98f138b19220041a7",
  "label": "Increase Revenue at least 10% in Q1",
  "targetValues": [
    {
      "targetValueTypeId": "588f7ee98f138b19220041a7"
    }
  ]
}

Response

updated

idstring required

globally unique id

orgIdstring required

parent organization id

goalIdstring required

goal id that this target belongs to

labelstring

human-readable name of the goal target

slugstring

url-safe slug for the goal target, auto-generated from goal slug and label if not provided

direction'MINIMIZE' | 'MAXIMIZE' | 'TARGET'

direction of the target -- whether we want to minimize or maximize the value

type'MILESTONE' | 'MONEY' | 'PERCENT' | 'INTEGER' | 'DECIMAL' required

type of the target value

valueExprstring

Carrot expression used to compute the current value versus target -- if not provided, GoalProgress will be used to track progress

startDatestring date required

start date for this goal target

endDatestring date required

end date for this goal target

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "goalId": "588f7ee98f138b19220041a7",
  "label": "Increase Revenue at least 10% in Q1",
  "targetValues": [
    {
      "targetValueTypeId": "588f7ee98f138b19220041a7"
    }
  ],
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z",
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteAt": "2017-01-24T13:57:52Z"
}