Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
goal

Update an existing goal

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

Path parameters

orgIdstring required

Org identifier (either id or slug)

goalIdstring required

Goal id

Request body

goalTypeIdstring

goal type

parentGoalIdstring

parent goal id, for cascading goals

originalGoalIdstring

original goal id, linking this goal to the goal it was copied from

relatedGoalIdsstring[]

list of other goals that are related to this goal

ownerPersonIdsstring[]

list of persons who are responsible for this goal

supportPersonIdsstring[]

list of persons who help support this goal

groupIdsstring[]

list of groups who are responsible for this goal

labelstring

human-readable name of the goal

slugstring

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

descriptionstring

human-readable description of the goal

startDatestring date

start date for this goal

endDatestring date

end date for this goal

sensitive'GLOBAL' | 'ORG' | 'SENSITIVE' | 'PERSONAL' | 'MANAGER' | 'HIGH' | 'PRIVATE'

sensitivity level of goal

Example request

{
  "goalTypeId": "588f7ee98f138b19220041a7",
  "parentGoalId": "588f7ee98f138b19220041a7",
  "originalGoalId": "588f7ee98f138b19220041a7",
  "relatedGoalIds": [
    "588f7ee98f138b19220041a7"
  ],
  "ownerPersonIds": [
    "588f7ee98f138b19220041a7"
  ],
  "supportPersonIds": [
    "588f7ee98f138b19220041a7"
  ],
  "groupIds": [
    "588f7ee98f138b19220041a7"
  ],
  "label": "Increase Revenue at least 10%",
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ],
  "progressUpdateConfig": {
    "schedule": "5 4 * * *"
  }
}

Response

updated

idstring required

globally unique id

orgIdstring required

parent organization id

status'DRAFT' | 'ACTIVE' | 'DONE' required

status

goalTypeIdstring required

goal type

parentGoalIdstring

parent goal id, for cascading goals

originalGoalIdstring

original goal id, linking this goal to the goal it was copied from

relatedGoalIdsstring[]

list of other goals that are related to this goal

ownerPersonIdsstring[]

list of persons who are responsible for this goal

supportPersonIdsstring[]

list of persons who help support this goal

groupIdsstring[]

list of groups who are responsible for this goal

labelstring required

human-readable name of the goal

slugstring required

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

descriptionstring

human-readable description of the goal

startDatestring date required

start date for this goal

endDatestring date required

end date for this goal

sensitive'GLOBAL' | 'ORG' | 'SENSITIVE' | 'PERSONAL' | 'MANAGER' | 'HIGH' | 'PRIVATE' required

sensitivity level of goal

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",
  "goalTypeId": "588f7ee98f138b19220041a7",
  "parentGoalId": "588f7ee98f138b19220041a7",
  "originalGoalId": "588f7ee98f138b19220041a7",
  "relatedGoalIds": [
    "588f7ee98f138b19220041a7"
  ],
  "ownerPersonIds": [
    "588f7ee98f138b19220041a7"
  ],
  "supportPersonIds": [
    "588f7ee98f138b19220041a7"
  ],
  "groupIds": [
    "588f7ee98f138b19220041a7"
  ],
  "label": "Increase Revenue at least 10%",
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ],
  "progressUpdateConfig": {
    "schedule": "5 4 * * *"
  },
  "progressSummary": {
    "id": "588f7ee98f138b19220041a7",
    "actuals": [
      {
        "goalTargetId": "588f7ee98f138b19220041a7"
      }
    ],
    "forecasts": [
      {
        "goalTargetId": "588f7ee98f138b19220041a7"
      }
    ],
    "targetValues": [
      {
        "goalTargetId": "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"
}